Skip to main content

API Surface

Enclava exposes a shared hosted CLI API through PaaS and a CAP API underneath it. Exact schemas should be generated from the OpenAPI contract or CAP API types.

Shared hosted CLI API

EndpointPurpose
/.well-known/enclavaDiscover API mode and CLI login endpoints.
/healthzLiveness.
/readyzReadiness.
/cli/loginBrowser approval entry for device login.
/auth/device/startStart device login.
/auth/device/pollPoll device login.
/users/meAuthenticated CLI principal and active organization.
/auth/api-keysCreate hosted API keys.
/auth/api-keys/{key_id}Revoke hosted API keys.
/platform/deployment-contextPublic deployment signing context.
/templatesList hosted templates.
/template-instancesCreate hosted template instances.
/apps/{app_name}/ssh-commandFetch the rendered stable SSH endpoint command.

CAP API responsibilities

CAP API owns app creation, deploy orchestration, deployment history, domains, config, org keyring state, workload artifacts, tenant TEE callbacks, and runtime status. PaaS routes hosted product flows to CAP without exposing CAP service credentials to the browser.