Management API

The REST API behind the CLI: projects, settings, keys, SQL, types, migrations, branches, functions, members, the audit log, and every dashboard feature (backups, compute, replicas, flags, queues, cron, push, links, metering, monitors and more), with an access token.

Base URL https://stitchdb.com/platform/v1. Authenticate with an access token (Authorization: Bearer sdb_pat_…). Read-only tokens can read everything their projects allow and run read-only SQL; changes need a read-write token. Tokens limited to some projects only see those. Requests are limited to about 5 per second per token (bursts of 120); over it you get 429 with Retry-After.

curl https://stitchdb.com/platform/v1/projects \
  -H "Authorization: Bearer $STITCHDB_TOKEN"

#Projects

#Project settings

#Organization: members and audit log

These need a dashboard session or a personal access token (not an organization or project token), and the Administrator or Owner role. <org> is the organization id from GET /organizations.

#Database

curl -X POST https://stitchdb.com/platform/v1/projects/<ref>/database/query \
  -H "Authorization: Bearer $STITCHDB_TOKEN" -H 'Content-Type: application/json' \
  -d '{"query":"select count(*) from public.todos","read_only":true}'

#Migrations

#Branches, functions and secrets

See Preview branches and Deploy functions with the API.

#Dashboard features

Everything below runs the same code as the dashboard, under /projects/<ref>. The rules of the dashboard apply: your role in the project (some changes need Administrator or Owner), the plan, and turning a feature on before you use it. Read-only tokens can call the GET routes (and the ones marked changes nothing) and see what a Developer sees. Organization tokens need the scopes in the last column. Answers never contain stored keys or signing secrets. The same routes are in the management client and the CLI.

#Backups

Restores and point-in-time recovery need the Administrator or Owner role. Download links are signed and expire; they need a read-write token.

#Compute

Changing the size and restarting need the Administrator or Owner role. A larger size is billed from the prepaid balance, like in the dashboard; POST /compute/estimate shows the price first.

#Replicas

Adding replicas needs the Administrator or Owner role and is billed hourly from the prepaid balance.

#Budget

Reading the budget needs billing:read as well (organization tokens). Changes need the Administrator or Owner role. The account-wide spend cap stays in the dashboard.

#Export

The list holds download links of the whole database, so it needs a read-write token. Restoring an archive into a project needs the organization owner.

#Feature flags

#Rate limits

#Inbound webhooks

Signing secrets are write-only: you set them, but they are never returned.

#Status page

#Cron

Needs pg_cron in the project (409 otherwise).

#Queues

Needs pgmq in the project (409 otherwise).

#Push notifications

Answers say which credentials are on file, never the keys themselves.

#In-app purchases

Answers say which store credentials are on file, never the keys. Webhook signing secrets are only shown in the dashboard.

#Deep links

#Metering

#Job monitoring

#Crash reporting

#Auth

Also see GET|PATCH /config/auth above. SSO providers need the Administrator or Owner role and auth:write.

#Recycle bin

#Change history

#Shared views

#Errors

Errors are JSON: { "error": "message" } with the HTTP status (400 invalid input or SQL error with code/detail/hint, 401 missing or invalid token, 403 not allowed, 404 not found or no access, 409 conflict, 429 rate limited).