Developers
API reference
REST, GraphQL, realtime and webhooks — fully typed and versioned.
REST, GraphQL, realtime and webhooks — versioned, typed and covered by a 12-month deprecation policy.
- Base URL
- https://api.nazexa.com/v4
- Auth
- Bearer tokens, OIDC
- Rate limit
- 1,000 req/min default
Authenticated request
Every endpoint accepts an idempotency key and returns a request ID you can quote to support.
bash
curl https://api.nazexa.com/v4/projects/prj_8fa2/branches \
-H "Authorization: Bearer $NAZEXA_TOKEN" \
-H "Idempotency-Key: 5c1f-branch-create" \
-d '{"name":"pr-482","from":"main"}'
# 201 Created
# x-request-id: req_01JBQ8Z3M4
# { "id": "brn_2f91", "status": "ready", "created_at": "2026-08-08T10:12:44Z" }Core endpoints
| Method | Path | Purpose |
|---|---|---|
| GET | /v4/projects | List projects visible to the token |
| POST | /v4/projects/:id/branches | Create a branch from a source branch |
| POST | /v4/projects/:id/deployments | Deploy functions to one or more regions |
| GET | /v4/projects/:id/metrics | Query latency, error and spend series |
| POST | /v4/webhooks | Register a signed webhook endpoint |
| DELETE | /v4/branches/:id | Tear down a branch and its storage |
Protocol guarantees
Idempotency
Any mutating call accepts an Idempotency-Key and replays the original response for 24 hours.
Cursor pagination
Stable cursors survive inserts and deletions; offsets are never used for large collections.
Signed webhooks
HMAC-SHA256 signatures, five automatic retries with exponential backoff and 30-day replay from the dashboard.
Error codes
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | Payload failed schema validation; see the errors array |
| 401 | unauthenticated | Missing, expired or revoked token |
| 403 | insufficient_scope | Token lacks the required scope for this resource |
| 409 | conflict | Resource changed since your last read; retry with a fresh ETag |
| 429 | rate_limited | Back off using the Retry-After header |
| 503 | region_unavailable | Retry against another region; the call is safe to repeat |
Generate a token
Create a scoped API token in the dashboard, or explore the schema in the interactive API playground.