Apex

HomeAPI Reference

Apex REST API.

Manage deployments, domains, and logs programmatically. All endpoints return JSON and authenticate with bearer tokens.

Authentication

Every request,Authorizationis sent with a bearer token in the header. Tokens are created per project from the dashboard and can be revoked at any time.

AuthorizationBearer apx_live_••••••••
Content-Typeapplication/json

Deployments

MethodEndpointDescription
GET/v2/deploymentsLists all deployments for a project
POST/v2/deploymentsStarts a new deployment
GET/v2/deployments/{id}Returns details for a single deployment
DELETE/v2/deployments/{id}Disables a deployment
POST/v2/deployments/{id}/rollbackRoutes traffic to the previous version

Domains

MethodEndpointDescription
GET/v2/domainsLists domains attached to a project
POST/v2/domainsAdds a domain and starts verification
PATCH/v2/domains/{id}Updates routing or certificate settings

Projects

MethodEndpointDescription
GET/v2/projectsLists all projects in the account
POST/v2/projectsCreates a new project from a repository connection

Logs

MethodEndpointDescription
GET/v2/logsReturns the latest function execution logs

Example response body:

{
  "region": "fra1",
  "status": 200,
  "durationMs": 4.8,
  "timestamp": "2026-09-10T08:14:02Z"
}

Error codes

CodeMeaning
400Invalid request body or missing field
401Token missing or invalid
404Resource not found
429Rate limit exceeded
500Unexpected server error

Rate limit

By default, 600 requests per minute are allowed; every responseX-RateLimit-Remainingincludes the rate-limit header. Custom limits can be defined for Enterprise plans.