Reference of the Management API for platforms: organizations, tokens, projects, limits, usage, webhooks, claim links. OpenAPI 3.1 document included.
Base URL https://stitchdb.com/platform/v1, JSON in and out, Authorization: Bearer <token>. The full machine-readable reference is the OpenAPI 3.1 document. Database, migrations, types, branches and functions: see Management API.
| Method and path | Scope | Does |
|---|---|---|
GET /organizations | — | Organizations this credential can act in |
GET|POST /organizations/<org>/tokens, DELETE …/<id> | people only | Organization tokens |
GET /organizations/<org>/usage | usage:read | Usage of every project (?from&to&format=csv) |
GET /organizations/<org>/billing | billing:read | Plan, limits, project count (owner) |
GET|POST /organizations/<org>/webhooks, PATCH|DELETE …/<id> | webhooks:write | Webhook endpoints; …/test, …/rotate-secret, …/deliveries, …/deliveries/<id>/redeliver |
GET|POST /projects | projects:read / write | List (labels, status, pagination) / create |
GET|PATCH|DELETE /projects/<ref> | projects:read / write | Read / rename, labels, expiry / delete |
POST /projects/<ref>/pause, /restore | projects:write | Pause / restore |
GET|PATCH /projects/<ref>/limits | projects:read / write | Per-project caps |
GET /projects/<ref>/usage | usage:read | Daily usage |
GET /projects/<ref>/api-keys, POST …/rotate | projects:read / write | Keys / rotation |
GET|POST /projects/<ref>/tokens, DELETE …/<id> | projects:read | Short-lived project tokens |
GET|PATCH /projects/<ref>/config/auth | projects:read / auth:write | Auth settings (admin) |
GET|POST /projects/<ref>/claim-links, DELETE …/<id> | projects:write | Claim links |
#Errors and limits
Errors are { "error": "message", "code"?: "…" } with the HTTP status: 400 invalid input, 401 invalid or expired token, 403 missing scope (code: missing_scope) or role, address not allowed (ip_not_allowed), 404 not found or not yours, 409 conflict, 422 idempotency mismatch, 429 rate limited, 503 no capacity (code: capacity). Each token has its own rate (default 5 requests/s for personal credentials, the token's rate_per_sec for organization tokens).