Supabase API V1

Supabase API (v1)

API version: 1.0.0

Auth

Bearer bearer

Base URL

Not specified.

Setup

1. Set Authorization header with your Bearer token
2. GET /v1/projects -- verify access
3. POST /v1/branches/{branch_id_or_ref}/push -- create first push

Endpoints

158 endpoints across 5 groups. See references/api-spec.lap for full details.

branches

projects

organizations

oauth

snippets

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Get branche details?" -> GET /v1/branches/{branch_id_or_ref}
• "Partially update a branche?" -> PATCH /v1/branches/{branch_id_or_ref}
• "Delete a branche?" -> DELETE /v1/branches/{branch_id_or_ref}
• "Create a push?" -> POST /v1/branches/{branch_id_or_ref}/push
• "Create a merge?" -> POST /v1/branches/{branch_id_or_ref}/merge
• "Create a reset?" -> POST /v1/branches/{branch_id_or_ref}/reset
• "Create a restore?" -> POST /v1/branches/{branch_id_or_ref}/restore
• "List all diff?" -> GET /v1/branches/{branch_id_or_ref}/diff
• "List all projects?" -> GET /v1/projects
• "Create a project?" -> POST /v1/projects
• "List all available-regions?" -> GET /v1/projects/available-regions
• "List all organizations?" -> GET /v1/organizations
• "Create a organization?" -> POST /v1/organizations
• "List all authorize?" -> GET /v1/oauth/authorize
• "Create a token?" -> POST /v1/oauth/token
• "Create a revoke?" -> POST /v1/oauth/revoke
• "List all project-claim?" -> GET /v1/oauth/authorize/project-claim
• "List all snippets?" -> GET /v1/snippets
• "Get snippet details?" -> GET /v1/snippets/{id}
• "List all actions?" -> GET /v1/projects/{ref}/actions
• "Get action details?" -> GET /v1/projects/{ref}/actions/{run_id}
• "List all logs?" -> GET /v1/projects/{ref}/actions/{run_id}/logs
• "List all api-keys?" -> GET /v1/projects/{ref}/api-keys
• "Create a api-key?" -> POST /v1/projects/{ref}/api-keys
• "List all legacy?" -> GET /v1/projects/{ref}/api-keys/legacy
• "Partially update a api-key?" -> PATCH /v1/projects/{ref}/api-keys/{id}
• "Get api-key details?" -> GET /v1/projects/{ref}/api-keys/{id}
• "Delete a api-key?" -> DELETE /v1/projects/{ref}/api-keys/{id}
• "List all branches?" -> GET /v1/projects/{ref}/branches
• "Create a branche?" -> POST /v1/projects/{ref}/branches
• "Get branche details?" -> GET /v1/projects/{ref}/branches/{name}
• "List all custom-hostname?" -> GET /v1/projects/{ref}/custom-hostname
• "Create a initialize?" -> POST /v1/projects/{ref}/custom-hostname/initialize
• "Create a reverify?" -> POST /v1/projects/{ref}/custom-hostname/reverify
• "Create a activate?" -> POST /v1/projects/{ref}/custom-hostname/activate
• "List all jit-access?" -> GET /v1/projects/{ref}/jit-access
• "Create a retrieve?" -> POST /v1/projects/{ref}/network-bans/retrieve
• "Create a enriched?" -> POST /v1/projects/{ref}/network-bans/retrieve/enriched
• "List all network-restrictions?" -> GET /v1/projects/{ref}/network-restrictions
• "Create a apply?" -> POST /v1/projects/{ref}/network-restrictions/apply
• "List all pgsodium?" -> GET /v1/projects/{ref}/pgsodium
• "List all postgrest?" -> GET /v1/projects/{ref}/postgrest
• "Get project details?" -> GET /v1/projects/{ref}
• "Delete a project?" -> DELETE /v1/projects/{ref}
• "Partially update a project?" -> PATCH /v1/projects/{ref}
• "List all secrets?" -> GET /v1/projects/{ref}/secrets
• "Create a secret?" -> POST /v1/projects/{ref}/secrets
• "List all ssl-enforcement?" -> GET /v1/projects/{ref}/ssl-enforcement
• "List all typescript?" -> GET /v1/projects/{ref}/types/typescript
• "List all vanity-subdomain?" -> GET /v1/projects/{ref}/vanity-subdomain
• "Create a check-availability?" -> POST /v1/projects/{ref}/vanity-subdomain/check-availability
• "Create a activate?" -> POST /v1/projects/{ref}/vanity-subdomain/activate
• "Create a upgrade?" -> POST /v1/projects/{ref}/upgrade
• "List all eligibility?" -> GET /v1/projects/{ref}/upgrade/eligibility
• "List all status?" -> GET /v1/projects/{ref}/upgrade/status
• "List all readonly?" -> GET /v1/projects/{ref}/readonly
• "Create a temporary-disable?" -> POST /v1/projects/{ref}/readonly/temporary-disable
• "Create a setup?" -> POST /v1/projects/{ref}/read-replicas/setup
• "Create a remove?" -> POST /v1/projects/{ref}/read-replicas/remove
• "List all health?" -> GET /v1/projects/{ref}/health
• "Create a legacy?" -> POST /v1/projects/{ref}/config/auth/signing-keys/legacy
• "List all legacy?" -> GET /v1/projects/{ref}/config/auth/signing-keys/legacy
• "Create a signing-key?" -> POST /v1/projects/{ref}/config/auth/signing-keys
• "List all signing-keys?" -> GET /v1/projects/{ref}/config/auth/signing-keys
• "Get signing-key details?" -> GET /v1/projects/{ref}/config/auth/signing-keys/{id}
• "Delete a signing-key?" -> DELETE /v1/projects/{ref}/config/auth/signing-keys/{id}
• "Partially update a signing-key?" -> PATCH /v1/projects/{ref}/config/auth/signing-keys/{id}
• "List all auth?" -> GET /v1/projects/{ref}/config/auth
• "Create a third-party-auth?" -> POST /v1/projects/{ref}/config/auth/third-party-auth
• "List all third-party-auth?" -> GET /v1/projects/{ref}/config/auth/third-party-auth
• "Delete a third-party-auth?" -> DELETE /v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}
• "Get third-party-auth details?" -> GET /v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}
• "Create a pause?" -> POST /v1/projects/{ref}/pause
• "List all restore?" -> GET /v1/projects/{ref}/restore
• "Create a restore?" -> POST /v1/projects/{ref}/restore
• "Create a cancel?" -> POST /v1/projects/{ref}/restore/cancel
• "List all addons?" -> GET /v1/projects/{ref}/billing/addons
• "Delete a addon?" -> DELETE /v1/projects/{ref}/billing/addons/{addon_variant}
• "List all claim-token?" -> GET /v1/projects/{ref}/claim-token
• "Create a claim-token?" -> POST /v1/projects/{ref}/claim-token
• "List all performance?" -> GET /v1/projects/{ref}/advisors/performance
• "List all security?" -> GET /v1/projects/{ref}/advisors/security
• "List all logs.all?" -> GET /v1/projects/{ref}/analytics/endpoints/logs.all
• "List all usage.api-counts?" -> GET /v1/projects/{ref}/analytics/endpoints/usage.api-counts
• "List all usage.api-requests-count?" -> GET /v1/projects/{ref}/analytics/endpoints/usage.api-requests-count
• "List all functions.combined-stats?" -> GET /v1/projects/{ref}/analytics/endpoints/functions.combined-stats
• "Create a login-role?" -> POST /v1/projects/{ref}/cli/login-role
• "List all migrations?" -> GET /v1/projects/{ref}/database/migrations
• "Create a migration?" -> POST /v1/projects/{ref}/database/migrations
• "Get migration details?" -> GET /v1/projects/{ref}/database/migrations/{version}
• "Partially update a migration?" -> PATCH /v1/projects/{ref}/database/migrations/{version}
• "Create a query?" -> POST /v1/projects/{ref}/database/query
• "Create a read-only?" -> POST /v1/projects/{ref}/database/query/read-only
• "Create a enable?" -> POST /v1/projects/{ref}/database/webhooks/enable
• "List all context?" -> GET /v1/projects/{ref}/database/context
• "List all jit?" -> GET /v1/projects/{ref}/database/jit
• "Create a jit?" -> POST /v1/projects/{ref}/database/jit
• "List all list?" -> GET /v1/projects/{ref}/database/jit/list
• "Delete a jit?" -> DELETE /v1/projects/{ref}/database/jit/{user_id}
• "List all functions?" -> GET /v1/projects/{ref}/functions
• "Create a function?" -> POST /v1/projects/{ref}/functions
• "Create a deploy?" -> POST /v1/projects/{ref}/functions/deploy
• "Get function details?" -> GET /v1/projects/{ref}/functions/{function_slug}
• "Partially update a function?" -> PATCH /v1/projects/{ref}/functions/{function_slug}
• "Delete a function?" -> DELETE /v1/projects/{ref}/functions/{function_slug}
• "List all body?" -> GET /v1/projects/{ref}/functions/{function_slug}/body
• "List all buckets?" -> GET /v1/projects/{ref}/storage/buckets
• "List all disk?" -> GET /v1/projects/{ref}/config/disk
• "Create a disk?" -> POST /v1/projects/{ref}/config/disk
• "List all util?" -> GET /v1/projects/{ref}/config/disk/util
• "List all autoscale?" -> GET /v1/projects/{ref}/config/disk/autoscale
• "List all storage?" -> GET /v1/projects/{ref}/config/storage
• "List all pgbouncer?" -> GET /v1/projects/{ref}/config/database/pgbouncer
• "List all pooler?" -> GET /v1/projects/{ref}/config/database/pooler
• "List all postgres?" -> GET /v1/projects/{ref}/config/database/postgres
• "List all realtime?" -> GET /v1/projects/{ref}/config/realtime
• "Create a shutdown?" -> POST /v1/projects/{ref}/config/realtime/shutdown
• "Create a provider?" -> POST /v1/projects/{ref}/config/auth/sso/providers
• "List all providers?" -> GET /v1/projects/{ref}/config/auth/sso/providers
• "Get provider details?" -> GET /v1/projects/{ref}/config/auth/sso/providers/{provider_id}
• "Update a provider?" -> PUT /v1/projects/{ref}/config/auth/sso/providers/{provider_id}
• "Delete a provider?" -> DELETE /v1/projects/{ref}/config/auth/sso/providers/{provider_id}
• "List all backups?" -> GET /v1/projects/{ref}/database/backups
• "Create a restore-pitr?" -> POST /v1/projects/{ref}/database/backups/restore-pitr
• "Create a restore-point?" -> POST /v1/projects/{ref}/database/backups/restore-point
• "List all restore-point?" -> GET /v1/projects/{ref}/database/backups/restore-point
• "Create a undo?" -> POST /v1/projects/{ref}/database/backups/undo
• "List all members?" -> GET /v1/organizations/{slug}/members
• "Get organization details?" -> GET /v1/organizations/{slug}
• "Get project-claim details?" -> GET /v1/organizations/{slug}/project-claim/{token}
• "Search projects?" -> GET /v1/organizations/{slug}/projects
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP