Instance API: Deployment Facts and Gateway Setup - OneCLI

The instance endpoints describe a OneCLI deployment and need no authentication. They report health, the edition and enabled features, the gateway URL, and the CA certificate agents trust. Use them to monitor a deployment or bootstrap an agent before it has a key. For running your own deployment, see Self-hosting.

Endpoints

Endpoint	Method and path	What it does
Health check	`GET /health`	Check that a OneCLI deployment is alive.
Get deployment facts	`GET /instance`	Get a deployment’s edition, enabled features, public URLs, and hosted-agent availability without authenticating.
Get the deployment’s egress addresses	`GET /instance/egress`	Get the source IP addresses a OneCLI deployment calls out from, so you can allowlist them on your services.
Get the gateway URL	`GET /gateway-url`	Get the HTTP address of a deployment’s gateway, which agents route their traffic through for credential injection.
Download the gateway CA certificate	`GET /gateway/ca`	Download the PEM certificate agents must trust so the gateway can inspect HTTPS traffic and inject credentials.

Next steps

API overview: base URLs, authentication, and pagination
Errors: status codes and the error format
Editions: which endpoints each edition serves