REST v3 • GraphQL beta

API Reference

Everything the dashboard and CLI can do is available over a JSON API. All requests go to https://api.cirrolane.dev.

Authentication

Send a workspace token as a bearer token. Create scoped tokens under Settings, then Tokens.

Rate limits

1,200 requests per minute per token. Remaining quota is returned in the response headers.

Errors

Errors use standard HTTP codes with a JSON body holding a code, a message and a request id.

Projects

A project groups deployments, domains, secrets and scaling rules for one application.

GET/v3/projectsList projects in the current workspace.

POST/v3/projectsCreate a project from a repository or an empty template.

GET/v3/projects/{id}Retrieve a single project with its current configuration.

PATCH/v3/projects/{id}Update regions, scaling limits or build settings.

DELETE/v3/projects/{id}Delete a project and all of its deployments.

Deployments

Every deployment is immutable. Promote, roll back or inspect any version at any time.

POST/v3/projects/{id}/deploymentsCreate a deployment from an uploaded bundle or a git ref.

GET/v3/deployments/{id}Fetch status, build output and region rollout progress.

POST/v3/deployments/{id}/promotePromote a preview deployment to production.

POST/v3/deployments/{id}/rollbackInstantly route traffic back to this deployment.

Request

curl -X POST https://api.cirrolane.dev/v3/projects/prj_8f2k/deployments \
  -H "Authorization: Bearer $CIRROLANE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "ref": "main", "target": "production" }'

Response 201

{
  "id": "dpl_41xq9",
  "status": "rolling_out",
  "regions": { "ready": 27, "total": 31 },
  "url": "https://acme-prod.cirrolane.dev",
  "createdAt": "2026-10-12T09:41:07Z"
}

Domains & TLS

Attach custom domains. Certificates are issued and renewed automatically.

GET/v3/projects/{id}/domainsList domains and their verification state.

POST/v3/projects/{id}/domainsAdd a domain and receive the DNS records to set.

DELETE/v3/domains/{name}Detach a domain from its project.

Environment & Secrets

Secrets are encrypted at rest and only decrypted inside the running isolate.

GET/v3/projects/{id}/envList variable names and the environments they apply to.

POST/v3/projects/{id}/envCreate or replace a variable for one or more environments.

DELETE/v3/projects/{id}/env/{key}Remove a variable. Takes effect on the next deployment.

Logs & Metrics

Stream logs in real time or query request metrics by region and status.

GET/v3/deployments/{id}/logsStream runtime logs as server-sent events.

GET/v3/projects/{id}/metricsRequest counts, latency percentiles and error rates.