Supabase API (v1)
Supabase API generated from the OpenAPI specification. Visit [https://supabase.com/docs](https://supabase.com/docs) for a complete documentation.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Supabase API generated from the OpenAPI specification. Visit https://supabase.com/docs for a complete documentation.
Endpoints 170
Advisors
- GETGets project performance advisors.
/v1/projects/:ref/advisors/performanceThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. - GETGets project security advisors.
/v1/projects/:ref/advisors/security?lint_type=sqlThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
Analytics
- GETGets project's logs
/v1/projects/:ref/analytics/endpoints/logs.allDeprecated. This endpoint has been removed and always responds with 410 Gone. Use GET /v1/projects/{ref}/analytics/endpoints/logs instead. See the migration… - GETGets all project's logs in a single log stream
/v1/projects/:ref/analytics/endpoints/logs?sql=select event_message from edge_logs limit 10&iso_timestamp_start=2025-03-01T00:00:00Z&iso_timestamp_end=2025-03-01T23:59:59ZExecutes an SQL or LQL query on the project's unified logs stream. Either the iso_timestamp_start and iso_timestamp_end parameters must be provided. If both… - GETGets project's usage api counts
/v1/projects/:ref/analytics/endpoints/usage.api-counts?interval=1day - GETGets project's usage api requests count
/v1/projects/:ref/analytics/endpoints/usage.api-requests-count - GETGets a project's function combined statistics
/v1/projects/:ref/analytics/endpoints/functions.combined-stats?interval=1hr&function_id=3c078cce-ad70-4148-9f37-4da362789053 - GETScrape a project's metrics
/v1/projects/:ref/analytics/endpoints/metricsPrometheus scrape endpoint. Returns metrics of a customer project in the Prometheus open exposition format.
Auth
- GETGet the signing key information for the JWT secret imported as signing key for this project. This endpoint will be removed in the future, check for HTTP 404 Not Found.
/v1/projects/:ref/config/auth/signing-keys/legacy - POSTSet up the project's existing JWT secret as an in_use JWT signing key. This endpoint will be removed in the future always check for HTTP 404 Not Found.
/v1/projects/:ref/config/auth/signing-keys/legacy - GETList all signing keys for the project
/v1/projects/:ref/config/auth/signing-keys - POSTCreate a new signing key for the project in standby status
/v1/projects/:ref/config/auth/signing-keys - GETGet information about a signing key
/v1/projects/:ref/config/auth/signing-keys/:id - DELETERemove a signing key from a project. Only possible if the key has been in revoked status for a while.
/v1/projects/:ref/config/auth/signing-keys/:id - PATCHUpdate a signing key, mainly its status
/v1/projects/:ref/config/auth/signing-keys/:id - GETGets project's auth config
/v1/projects/:ref/config/auth - PATCHUpdates a project's auth config
/v1/projects/:ref/config/auth - GETLists all third-party auth integrations
/v1/projects/:ref/config/auth/third-party-auth - POSTCreates a new third-party auth integration
/v1/projects/:ref/config/auth/third-party-auth - GETGet a third-party integration
/v1/projects/:ref/config/auth/third-party-auth/:tpa_id - DELETERemoves a third-party auth integration
/v1/projects/:ref/config/auth/third-party-auth/:tpa_id - GETLists all SSO providers
/v1/projects/:ref/config/auth/sso/providers - POSTCreates a new SSO provider
/v1/projects/:ref/config/auth/sso/providers - GETGets a SSO provider by its UUID
/v1/projects/:ref/config/auth/sso/providers/:provider_id - PUTUpdates a SSO provider by its UUID
/v1/projects/:ref/config/auth/sso/providers/:provider_id - DELETERemoves a SSO provider by its UUID
/v1/projects/:ref/config/auth/sso/providers/:provider_id
Billing
- GETList billing addons and compute instance selections
/v1/projects/:ref/billing/addonsReturns the billing addons that are currently applied, including the active compute instance size, and lists every addon option that can be provisioned with… - PATCHApply or update billing addons, including compute instance size
/v1/projects/:ref/billing/addonsSelects an addon variant, for example scaling the project’s compute instance up or down, and applies it to the project. - DELETERemove billing addons or revert compute instance sizing
/v1/projects/:ref/billing/addons/:addon_variantDisables the selected addon variant, including rolling the compute instance back to its previous size.
Database
- GETLists SQL snippets for the logged in user
/v1/snippets?project_ref=abcdefghijklmnopqrst&cursor=string&limit=string&sort_by=name&sort_order=asc - GETGets a specific SQL snippet
/v1/snippets/:id - GETGet project's temporary access configuration.
/v1/projects/:ref/jit-accessThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - PUTUpdate project's temporary access configuration.
/v1/projects/:ref/jit-accessThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETGet project's SSL enforcement configuration.
/v1/projects/:ref/ssl-enforcementThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - PUTUpdate project's SSL enforcement configuration.
/v1/projects/:ref/ssl-enforcementThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETGenerate TypeScript types
/v1/projects/:ref/types/typescript?included_schemas=public,authReturns the TypeScript types of your schema for use with supabase-js. - GETReturns project's readonly mode status
/v1/projects/:ref/readonly - POSTDisables project's readonly mode for the next 15 minutes
/v1/projects/:ref/readonly/temporary-disable - POSTSet up a read replica
/v1/projects/:ref/read-replicas/setupThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTRemove a read replica
/v1/projects/:ref/read-replicas/removeThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTCreate a login role for CLI with temporary password
/v1/projects/:ref/cli/login-roleThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - DELETEDelete existing login roles used by CLI
/v1/projects/:ref/cli/login-roleThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETList applied migration versions
/v1/projects/:ref/database/migrations - PUTUpsert a database migration without applying
/v1/projects/:ref/database/migrations - POSTApply a database migration
/v1/projects/:ref/database/migrations - DELETERollback database migrations and remove them from history table
/v1/projects/:ref/database/migrations?gte=20250312000000 - GETFetch an existing entry from migration history
/v1/projects/:ref/database/migrations/:version - PATCHPatch an existing entry in migration history
/v1/projects/:ref/database/migrations/:version - POSTRun sql query
/v1/projects/:ref/database/queryThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTRun a sql query as supabase_read_only_user
/v1/projects/:ref/database/query/read-onlyAll entity references must be schema qualified. This endpoint is currently in its Beta stage. - POSTEnables Database Webhooks on the project
/v1/projects/:ref/database/webhooks/enableThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETGets database metadata for the given project.
/v1/projects/:ref/database/contextThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. - PATCHUpdates the database password
/v1/projects/:ref/database/password - GETGet user-id to role mappings for JIT access
/v1/projects/:ref/database/jitMappings of roles a user can assume in the project database - PUTUpdates a user mapping for JIT access
/v1/projects/:ref/database/jitModifies the roles that can be assumed and for how long - POSTAuthorize user-id to role mappings for JIT access
/v1/projects/:ref/database/jitAuthorizes the request to assume a role in the project database - GETList all user-id to role mappings for JIT access
/v1/projects/:ref/database/jit/listMappings of roles a user can assume in the project database - POSTInvites an external user to a database for JIT access
/v1/projects/:ref/database/jit/inviteInvites the external user and sets initial roles that can be assumed and for how long - POSTAccepts invitation for JIT database access
/v1/projects/:ref/database/jit/invite/acceptAccepts the invitation to JIT database access - DELETEDeletes the invite for an external user to a database for JIT access
/v1/projects/:ref/database/jit/invite/:invite_idRevokes and deletes the invitation - DELETEDelete JIT access by user-id
/v1/projects/:ref/database/jit/:user_idRemove JIT mappings of a user, revoking all JIT database access - GETGet PostgREST OpenAPI spec
/v1/projects/:ref/database/openapi?schema=publicReturns the PostgREST OpenAPI specification for the project. This is the replacement for querying /rest/v1/ directly with the anon key. - GETGet project's pgbouncer config
/v1/projects/:ref/config/database/pgbouncer - GETGets project's supavisor config
/v1/projects/:ref/config/database/pooler - PATCHUpdates project's supavisor config
/v1/projects/:ref/config/database/pooler - GETGets project's Postgres config
/v1/projects/:ref/config/database/postgres - PUTUpdates project's Postgres config
/v1/projects/:ref/config/database/postgres - GETLists all backups
/v1/projects/:ref/database/backups - POSTRestores a PITR backup for a database
/v1/projects/:ref/database/backups/restore-pitr - GETGet restore points for project
/v1/projects/:ref/database/backups/restore-point?name=string - POSTInitiates a creation of a restore point for a database
/v1/projects/:ref/database/backups/restore-point - POSTRestores a physical backup for a database
/v1/projects/:ref/database/backups/restore - GETGets the backup schedule for a project
/v1/projects/:ref/database/backups/schedule - PATCHUpdates the backup schedule time for a project
/v1/projects/:ref/database/backups/scheduleSets the time at which the daily backup runs. The change takes effect on the next backup window that includes the new time. If the new time has already passed… - POSTInitiates an undo to a given restore point
/v1/projects/:ref/database/backups/undo
Domains
- GETGets project's custom hostname config
/v1/projects/:ref/custom-hostnameThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - DELETEDeletes a project's custom hostname configuration
/v1/projects/:ref/custom-hostname?remove_addon=stringThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTUpdates project's custom hostname configuration
/v1/projects/:ref/custom-hostname/initializeThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTAttempts to verify the DNS configuration for project's custom hostname configuration
/v1/projects/:ref/custom-hostname/reverifyThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTActivates a custom hostname for a project.
/v1/projects/:ref/custom-hostname/activateThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETGets current vanity subdomain config
/v1/projects/:ref/vanity-subdomainThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - DELETEDeletes a project's vanity subdomain configuration
/v1/projects/:ref/vanity-subdomainThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTChecks vanity subdomain availability
/v1/projects/:ref/vanity-subdomain/check-availabilityThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTActivates a vanity subdomain for a project.
/v1/projects/:ref/vanity-subdomain/activateThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This…
Edge Functions
- GETList all functions
/v1/projects/:ref/functionsReturns all functions you've previously added to the specified project. - PUTBulk update functions
/v1/projects/:ref/functionsBulk update functions. It will create a new function or replace existing. The operation is idempotent. NOTE: You will need to manually bump the version. - POSTCreate a function
/v1/projects/:ref/functions?slug=hello-world&name=Hello World&verify_jwt=true&import_map=false&entrypoint_path=index.ts&import_map_path=import_map.json&ezbr_sha256=44c691990518d25498f0fd80cf6631ecf2b58eb9c5eb2a087dd1688f2904dac7Deprecated. This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project. - POSTDeploy a function
/v1/projects/:ref/functions/deploy?slug=hello-world&bundleOnly=falseA new endpoint to deploy functions. It will create if function does not exist. - GETRetrieve a function
/v1/projects/:ref/functions/:function_slugRetrieves a function with the specified slug and project. - DELETEDelete a function
/v1/projects/:ref/functions/:function_slugDeletes a function with the specified slug from the specified project. - PATCHUpdate a function
/v1/projects/:ref/functions/:function_slug?slug=hello-world&name=Hello World&verify_jwt=true&import_map=false&entrypoint_path=index.ts&import_map_path=import_map.json&ezbr_sha256=44c691990518d25498f0fd80cf6631ecf2b58eb9c5eb2a087dd1688f2904dac7Updates a function with the specified slug and project. - GETRetrieve a function body
/v1/projects/:ref/functions/:function_slug/bodyRetrieves a function body for the specified slug and project.
Environments
- GETGet database branch config
/v1/branches/:branch_id_or_refFetches configurations of the specified database branch - DELETEDelete a database branch
/v1/branches/:branch_id_or_ref?force=falseDeletes the specified database branch. By default, deletes immediately. Use force=false to schedule deletion with 1-hour grace period (only when soft deletion… - PATCHUpdate database branch config
/v1/branches/:branch_id_or_refUpdates the configuration of the specified database branch - POSTPushes a database branch
/v1/branches/:branch_id_or_ref/pushPushes the specified database branch - POSTMerges a database branch
/v1/branches/:branch_id_or_ref/mergeMerges the specified database branch - POSTResets a database branch
/v1/branches/:branch_id_or_ref/resetResets the specified database branch - POSTRestore a scheduled branch deletion
/v1/branches/:branch_id_or_ref/restoreCancels scheduled deletion and restores the branch to active state - GETDiffs a database branch
/v1/branches/:branch_id_or_ref/diff?included_schemas=public,auth&pgdelta=trueDiffs the specified database branch This endpoint is currently in its Beta stage. - GETList all action runs
/v1/projects/:ref/actions?offset=0&limit=20Returns a paginated list of action runs of the specified project. - HEADCount the number of action runs
/v1/projects/:ref/actionsReturns the total number of action runs of the specified project. - GETGet the status of an action run
/v1/projects/:ref/actions/:run_idReturns the current status of the specified action run. - PATCHUpdate the status of an action run
/v1/projects/:ref/actions/:run_id/statusUpdates the status of an ongoing action run. - GETGet the logs of an action run
/v1/projects/:ref/actions/:run_id/logsReturns the logs from the specified action run. - GETList all database branches
/v1/projects/:ref/branchesReturns all database branches of the specified project. - POSTCreate a database branch
/v1/projects/:ref/branchesCreates a database branch from the specified project. - DELETEDisables preview branching
/v1/projects/:ref/branchesDisables preview branching for the specified project - GETGet a database branch
/v1/projects/:ref/branches/:nameFetches the specified database branch by its name.
OAuth
- GETAuthorize user through oauth
/v1/oauth/authorize?client_id=66666666-6666-4666-8666-666666666666&response_type=code&redirect_uri=https://app.acme.com/auth/callback&scope=projects:read projects:write&state=st_9f4d3a206b2e4a7e8c91&response_mode=query&code_challenge=Z_P4EKbGwIkA01e3Y5fp4tMCvn_Ae5nUw7qY7XwkTrQ&code_challenge_method=S256&organization_slug=tsrqponmlkjihgfedcba&target_flow=string&resource=https://mcp.supabase.com/projectsThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTExchange auth code for user's access and refresh token
/v1/oauth/tokenSupports authorization_code, refresh_token, and urn:ietf:params:oauth:grant-type:jwt-bearer grant types. The jwt-bearer grant type (IDJAG — identity-directed… - POSTRevoke oauth app authorization and it's corresponding tokens
/v1/oauth/revokeThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETAuthorize user through oauth and claim a project
/v1/oauth/authorize/project-claim?project_ref=abcdefghijklmnopqrst&client_id=66666666-6666-4666-8666-666666666666&response_type=code&redirect_uri=https://app.acme.com/auth/callback&state=st_9f4d3a206b2e4a7e8c91&response_mode=query&code_challenge=Z_P4EKbGwIkA01e3Y5fp4tMCvn_Ae5nUw7qY7XwkTrQ&code_challenge_method=S256Initiates the OAuth authorization flow for the specified provider. After successful authentication, the user can claim ownership of the specified project.
Organizations
- GETList all organizations
/v1/organizationsReturns a list of organizations that you currently belong to. - POSTCreate an organization
/v1/organizations - GETGet entitlements for an organization
/v1/organizations/:slug/entitlementsReturns the entitlements available to the organization based on their plan and any overrides. - GETList members of an organization
/v1/organizations/:slug/members - GETGets information about the organization
/v1/organizations/:slug - GETGets project details for the specified organization and claim token
/v1/organizations/:slug/project-claim/:token - POSTClaims project for the specified organization
/v1/organizations/:slug/project-claim/:token
Projects
- GETList all projects
/v1/projectsReturns a list of all projects you've previously created. - POSTCreate a project
/v1/projects - GETGets the list of available regions that can be used for a new project
/v1/projects/available-regions?organization_slug=tsrqponmlkjihgfedcba&continent=NA&desired_instance_size=nanoThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTGets project's network bans
/v1/projects/:ref/network-bans/retrieveThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTGets project's network bans with additional information about which databases they affect
/v1/projects/:ref/network-bans/retrieve/enrichedThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - DELETERemove network bans.
/v1/projects/:ref/network-bansThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETGets project's network restrictions
/v1/projects/:ref/network-restrictionsThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - PATCHUpdates project's network restrictions by adding or removing CIDRs
/v1/projects/:ref/network-restrictionsThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - POSTUpdates project's network restrictions
/v1/projects/:ref/network-restrictions/applyThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETGets a specific project that belongs to the authenticated user
/v1/projects/:ref - DELETEDeletes the given project
/v1/projects/:ref - PATCHUpdates the given project
/v1/projects/:ref - POSTUpgrades the project's Postgres version
/v1/projects/:ref/upgradeThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETReturns the project's eligibility for upgrades
/v1/projects/:ref/upgrade/eligibilityThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETGets the latest status of the project's upgrade
/v1/projects/:ref/upgrade/status?tracking_id=9f4d3a20-6b2e-4a7e-8c91-1d5f3e7a2b4cThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETGets project's service health status
/v1/projects/:ref/health?services=auth,db,auth&timeout_ms=2000 - POSTPauses the given project
/v1/projects/:ref/pause - POSTRestarts the given project
/v1/projects/:ref/restart - GETLists available restore versions for the given project
/v1/projects/:ref/restore - POSTRestores the given project
/v1/projects/:ref/restore - POSTCancels the given project restoration
/v1/projects/:ref/restore/cancel - GETGets project claim token
/v1/projects/:ref/claim-token - POSTCreates project claim token
/v1/projects/:ref/claim-token - DELETERevokes project claim token
/v1/projects/:ref/claim-token - GETGet database disk attributes
/v1/projects/:ref/config/disk - POSTModify database disk
/v1/projects/:ref/config/disk - GETGet disk utilization
/v1/projects/:ref/config/disk/util - GETGets project disk autoscale config
/v1/projects/:ref/config/disk/autoscale - GETGets all projects for the given organization
/v1/organizations/:slug/projects?offset=0&limit=20&search=acme&sort=created_desc&statuses=ACTIVE_HEALTHY,INACTIVEReturns a paginated list of projects for the specified organization. This endpoint uses offset-based pagination. Use the offset parameter to skip a number of…
Rest
- GETGets project's postgrest config
/v1/projects/:ref/postgrest - PATCHUpdates project's postgrest config
/v1/projects/:ref/postgrest
Secrets
- GETGet project api keys
/v1/projects/:ref/api-keys?reveal=true - POSTCreates a new API key for the project
/v1/projects/:ref/api-keys?reveal=true - GETCheck whether JWT based legacy (anon, service_role) API keys are enabled. This API endpoint will be removed in the future, check for HTTP 404 Not Found.
/v1/projects/:ref/api-keys/legacy - PUTDisable or re-enable JWT based legacy (anon, service_role) API keys. This API endpoint will be removed in the future, check for HTTP 404 Not Found.
/v1/projects/:ref/api-keys/legacy?enabled=true - GETGet API key
/v1/projects/:ref/api-keys/:id?reveal=true - DELETEDeletes an API key for the project
/v1/projects/:ref/api-keys/:id?reveal=true&was_compromised=false&reason=rotating_key - PATCHUpdates an API key for the project
/v1/projects/:ref/api-keys/:id?reveal=true - GETGets project's pgsodium config
/v1/projects/:ref/pgsodiumThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - PUTUpdates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.
/v1/projects/:ref/pgsodiumThis is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable. This… - GETList all secrets
/v1/projects/:ref/secretsReturns all secrets you've previously added to the specified project. - POSTBulk create secrets
/v1/projects/:ref/secretsCreates multiple secrets and adds them to the specified project. - DELETEBulk delete secrets
/v1/projects/:ref/secretsDeletes all secrets with the given names from the specified project
Storage
- GETLists all buckets
/v1/projects/:ref/storage/buckets - GETGets project's storage config
/v1/projects/:ref/config/storage - PATCHUpdates project's storage config
/v1/projects/:ref/config/storage
Profile
- GETGets the user's profile
/v1/profile
Realtime
- GETGets realtime configuration
/v1/projects/:ref/config/realtime - PATCHUpdates realtime configuration
/v1/projects/:ref/config/realtime - POSTShutdowns realtime connections for a project
/v1/projects/:ref/config/realtime/shutdown
API details
- Base URL
https://api.supabase.com- Authentication
- A bearer token in the Authorization header
OAuth 2.0 (authorization code flow) with 24 scopes - Operations
- 170 operations on 115 pathsGET 77POST 49DELETE 18PATCH 16PUT 9HEAD 1
2 marked deprecated - Main resources
- Database 46Projects 29Auth 18Environments 17Secrets 12Domains 9Edge Functions 8Organizations 7Analytics 6OAuth 4
- Response formats
application/jsontext/plainapplication/openmetrics-text- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Supabase's published OpenAPI description (supabase/supabase) (Apache-2.0)
How to test the Supabase API (v1) in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Supabase API (v1) collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets project performance advisors.” (GET /v1/projects/:ref/advisors/performance), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Supabase API (v1)?
Supabase API generated from the OpenAPI specification. Visit [https://supabase.com/docs](https://supabase.com/docs) for a complete documentation. It is listed under Developer tools and has 170 endpoints.
Who publishes the Supabase API (v1)?
It is listed from Supabase's public API description (an OpenAPI document), not published by Supabase on Swastik Codes. Anyone who controls supabase.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Supabase API (v1)?
Requests go to https://api.supabase.com. Endpoint paths are added to this base URL.
How do I authenticate with the Supabase API (v1)?
It accepts 2 methods: A bearer token in the Authorization header; OAuth 2.0 (authorization code flow) with 24 scopes.
How many endpoints does the Supabase API (v1) have?
170 operations on 115 paths (77 GET, 49 POST, 18 DELETE, 16 PATCH, 9 PUT, 1 HEAD). The largest groups are Database, Projects, Auth, Environments.
Is forking the Supabase API (v1) free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.