> ## Documentation Index
> Fetch the complete documentation index at: https://onecli.sh/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Instance API: Deployment Facts and Gateway Setup

> Check health, read deployment facts, get egress addresses, and download the gateway CA with the OneCLI API. No auth needed.

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](https://onecli.sh/docs/self-hosting/overview.md).

## Related guides

* [Self-hosting overview](https://onecli.sh/docs/self-hosting/overview.md)
* [Connect agents to a self-hosted deployment](https://onecli.sh/docs/self-hosting/connect-agents.md)

## Endpoints

| Endpoint | Method and path | What it does |
| - | - | - |
| [Health check](https://onecli.sh/docs/api-reference/instance/health-check.md) | `GET /health` | Check that a OneCLI deployment is alive. |
| [Get deployment facts](https://onecli.sh/docs/api-reference/instance/get-deployment-facts.md) | `GET /instance` | Get a deployment's edition, enabled features, public URLs, and hosted-agent availability without authenticating. |
| [Get the deployment's egress addresses](https://onecli.sh/docs/api-reference/instance/get-the-deployments-egress-addresses.md) | `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](https://onecli.sh/docs/api-reference/instance/get-the-gateway-url.md) | `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](https://onecli.sh/docs/api-reference/instance/download-the-gateway-ca-certificate.md) | `GET /gateway/ca` | Download the PEM certificate agents must trust so the gateway can inspect HTTPS traffic and inject credentials. |

## Next steps

* [API overview](https://onecli.sh/docs/api-reference.md): base URLs, authentication, and pagination
* [Errors](https://onecli.sh/docs/api-reference/errors.md): status codes and the error format
* [Editions](https://onecli.sh/docs/api-reference/editions.md): which endpoints each edition serves


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.