Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.zerct.com/llms.txt

Use this file to discover all available pages before exploring further.

Use status endpoints only to understand Zerct availability. Use logs and deploy responses to debug your project.

​
Endpoints

curl https://api.zerct.com/health
curl https://api.zerct.com/v1/status
/health is the simple human-friendly health alias. /healthz remains the infrastructure probe for load balancers and deploy scripts. /v1/status is the structured endpoint for SDKs and agents: 
{
  "ok": true,
  "service": "zerct-api",
  "api_version": "v1",
  "checks": [
    {
      "name": "control_plane_database",
      "ok": true,
      "message": "reachable"
    }
  ],
  "agent_instruction": "Continue with GET /v1/capabilities, then run the requested Zerct command.",
  "docs_url": "https://docs.zerct.com/status"
}
If ok is true, continue with GET /v1/capabilities or the CLI command you were running. If ok is false, retry later before changing project code.

​
Agent Rule

Do not use status as a project debugger. After deploy failures, inspect build logs instead: 
npx @zerct/zerct logs --build <build_id> --json
Last modified on May 27, 2026