REST API reference

Keeper serves the REST API under /api/v1. The reference below is rendered from the OpenAPI document committed as docs/openapi.json; a test fails when it differs from the application, and a running Keeper serves the same document at /api/v1/openapi.json. The Python client and the command line are checked against it.

For authentication, roles and the error format see the design and the security review. Agents that prefer tools to HTTP use the MCP server.

Open the reference on its own page, or download openapi.json.