Accept Invite External Jit AccessAccept an invitation for JIT database access.
Create project api keyCreates a publishable or secret API key for an existing Supabase project, optionally with a description.
Delete an API key from the projectPermanently deletes a specific API key (identified by `id`) from a Supabase project (identified by `ref`), revoking its access.
Delete third party auth configRemoves a third-party authentication provider (e.
Get a third-party integrationRetrieves the detailed configuration for a specific third-party authentication (TPA) provider, identified by `tpa_id`, within an existing Supabase project specified by `ref`.
List third-party auth integrations for projectLists all configured third-party authentication provider integrations for an existing Supabase project (using its `ref`), suitable for read-only auditing or verifying current authentication settings.
Update an API key for the projectUpdates the description of an existing Supabase project API key without regenerating the key string.
Append Resumable UploadAppend data to a TUS resumable upload.
Append Resumable Upload SignedAppend data to a signed resumable upload.
Apply a database migrationApplies a tracked SQL database migration to a Supabase project, for schema changes or other DDL/DML operations.
Apply Project AddonApply or update billing addons and compute instance size.
Authorize Jit AccessAuthorize user-to-role mappings for JIT access.
Beta activate custom hostname for projectActivates a previously configured custom hostname for a Supabase project, assuming DNS settings are verified externally.
Activate vanity subdomain for projectActivates a vanity subdomain for the specified Supabase project (e.
Authorize user through OAuthRequests Supabase OAuth 2.
Check vanity subdomain availabilityChecks whether a vanity subdomain is available for a Supabase project without reserving or assigning it.
Setup read replica for projectProvisions a read-only replica for a Supabase project in a specified supported AWS region to enhance read performance and reduce latency.
Enable project database webhooksEnables database webhooks for the Supabase project `ref`, triggering real-time notifications for INSERT, UPDATE, or DELETE events.
Beta get project's custom hostname configRetrieves a Supabase project's custom hostname configuration, including its status, SSL certificate, and ownership verification, noting that availability may depend on the project's plan.
Retrieve network bans for projectRetrieves the list of banned IPv4 addresses for a Supabase project using its unique project reference string; this is a read-only operation.
Get project network restrictionsRetrieves a Supabase project's network restriction settings, including IPv4 and IPv6 CIDR allowlists, entitlement, and application status.
Get project pgsodium configRetrieves the PGSodium configuration, including the root encryption key, for an existing Supabase project identified by its `ref`.
Get project SSL enforcement configurationRetrieves the SSL enforcement configuration for a specified Supabase project, indicating if SSL connections are mandated for its database.
Get current vanity subdomain configFetches the current vanity subdomain configuration for a Supabase project, including its status and any custom domain name.
Remove project network bansRemoves specified IPv4 addresses from a Supabase project's network ban list, granting immediate access; IPs not currently banned are ignored.
Remove read replicaInitiates removal of a specified read replica database from a Supabase project.
Execute project database queryExecutes PostgreSQL queries against a Supabase project's database for data retrieval, modification, or schema operations.
Beta update project network restrictionsUpdates network access restrictions (IPv4/IPv6 CIDR lists) for a Supabase project.
Upgrade the project's PostgreSQL versionInitiates an asynchronous upgrade of a Supabase project's PostgreSQL database to a specified `target_version` from a selected `release_channel`, returning a `tracking_id` to monitor status; the `target_version` must be available in the chosen channel.
Cancel Project RestorationCancel project restoration.
Copy Storage ObjectCopy an object.
Count action runsCounts the number of action runs for a Supabase project using a HEAD request.
Count Function ResultsCount rows from a known exposed table-valued function using HEAD, without a body.
Count Table RowsCount matching rows in an exposed table or view without downloading rows.
Create new projectCreates a new Supabase project, requiring a unique name (no dots) within the organization; project creation is asynchronous.
Bulk create secretsBulk creates secrets for a Supabase project.
Create a database branchCreates a new, isolated database branch from an existing Supabase project (identified by `ref`), useful for setting up separate environments like development or testing, which can optionally be linked to a Git branch.
Create a functionCreates a new serverless Edge Function for a Supabase project (identified by `ref`), requiring valid JavaScript/TypeScript in `body` and a project-unique `slug` identifier.
Create CLI login roleCreates a temporary CLI login role for database access with specified permissions; use when setting up CLI authentication for development or administrative tasks.
Create an organizationCreates a new Supabase organization, which serves as a top-level container for projects, billing, and team access.
Create project signing keyCreate a new JWT signing key for a Supabase project, with an optional initial standby or in-use status.
Create Resumable UploadCreate a TUS resumable upload.
Create Resumable Upload SignedCreate a signed TUS resumable upload.
Create Signed Download UrlGenerate a time-limited download capability for an object.
Create Signed Download UrlsGenerate time-limited download capabilities for multiple objects.
Create Signed Upload URLCreate a two-hour signed authorization for uploading a Storage object.
Create SSO provider configurationCreates a new SAML 2.
Create Storage BucketCreate a Storage bucket.
Create a new third-party auth integrationCall this to add a new third-party authentication method (OIDC or JWKS) to a Supabase project for integrating external identity providers (e.
Delete all branchesDisables preview branching for a Supabase project, which deletes all remaining branches.
Delete Bucket LifecycleDelete bucket lifecycle configuration.
Delete custom hostname configDeletes an active custom hostname configuration for the project identified by `ref`, reverting to the default Supabase-provided hostname; this action immediately makes the project inaccessible via the custom domain and requires subsequent updates to client, OAuth, and DNS settings.
Delete branch by idPermanently and irreversibly deletes a specific, non-default database branch by its `branch_id`, without affecting other branches.
Delete edge functionDeletes an Edge Function from a Supabase project by its slug.
Delete an edge function by slugPermanently deletes a specific Edge Function (by `function_slug`) from a Supabase project (by `ref`); this action is irreversible and requires prior existence of both project and function.
Delete Invite External Jit AccessDelete an external user's JIT invitation.
Delete Jit AccessDelete JIT access by user ID.
Delete CLI login roles[Beta] Deletes existing login roles used by the Supabase CLI for the specified project.
Delete a projectPermanently and irreversibly deletes a Supabase project and all associated resources, including databases, storage, and configurations.
Delete vanity subdomain for projectPermanently and irreversibly deletes an active vanity subdomain configuration for the specified Supabase project, reverting it to its default Supabase URL.
Bulk delete secretsDeletes one or more secrets from a Supabase project by their names.
Remove an SSO providerDeletes a specific SSO provider by its ID (`provider_id`) from a Supabase project (`ref`), which disables it and returns its details; ensure this action will not inadvertently lock out users.
Delete Storage BucketDelete a bucket.
Delete Storage ObjectDelete a Storage object.
Delete Storage ObjectsDelete multiple objects.
Delete Table RowsPermanently delete matching rows from an exposed Supabase table or view.
Deploy functionDeploys Edge Functions to a Supabase project using multipart upload.
Disable preview branchingDisables the preview branching feature for an existing Supabase project, identified by its unique reference ID (`ref`).
Disable project readonly modeTemporarily disables a Supabase project's read-only mode for 15 minutes to allow write operations (e.
Download private objectDownloads an object from a private Supabase Storage bucket and returns its bytes as base64 with selected metadata.
Download Public ObjectRetrieve an object from a public bucket.
Download Signed ObjectRetrieve an object using a presigned URL.
Download Storage ObjectRetrieve a Storage object.
Empty Storage BucketEmpty a bucket.
Exchange auth code for access and refresh token(Beta) Implements the OAuth 2.
Generate TypeScript typesGenerates and retrieves TypeScript types from a Supabase project's database; any schemas specified in `included_schemas` must exist in the project.
Get action run statusRetrieves the status and details of a specific action run, including its steps, timestamps, and configuration.
Get action run logsRetrieves the execution logs for a specific action run by its ID.
Get project auth configRetrieves a Supabase project's authentication settings for read-only inspection, including supported provider configurations, MFA policies, email and SMS templates, security settings, and hooks.
Get Authenticated Image HeadersGet authenticated image transformation headers.
Get Authenticated Object HeadersRetrieve authenticated object information headers.
Get Authenticated Object InfoRetrieve authenticated object information.
Get Authenticated Object Info HeadersGet authenticated object information headers.
Get Available RegionsTool to get the list of available regions for creating a new Supabase project.
Get Backup ScheduleGet the project's backup schedule.
Get a database branchRetrieves detailed information about a specific database branch by its name and project reference.
Get Bucket LifecycleGet bucket lifecycle configuration.
Get Bucket Lifecycle HeadersGet bucket lifecycle response headers.
Get database branch configRetrieves the read-only configuration and status for a Supabase database branch, typically for monitoring or verifying its settings.
Get Database DiskGet database disk attributes.
Get Database OpenapiGet the project's PostgREST OpenAPI specification.
Get Disk UtilizationGet disk utilization.
Retrieve a functionRetrieves detailed information, metadata, configuration, and status for a specific Edge Function using its project reference ID and function slug.
Retrieve a function bodyRetrieves the body of a specified Supabase Edge Function using its project reference and function slug.
Get API Health StatusChecks the Supabase API for availability, helping diagnose connectivity issues.
Get Jit AccessGet user-to-role mappings for JIT database access.
Get JIT access configRetrieves a Supabase project's just-in-time (JIT) access configuration state using the beta endpoint.
Get a migrationRetrieves a specific database migration entry from the migration history using its version identifier.
Get information about an organizationFetches comprehensive details for a specific Supabase organization using its unique slug.
Get Organization EntitlementsGet organization entitlements.
Get ProfileGet the user's profile.
Get projectRetrieves detailed information about a Supabase project by reference ID, including its status, database configuration, organization, region, and creation timestamp.
Get project API keyRetrieves details of a specific API key for a Supabase project by its UUID.
Get project API keysRetrieves all API keys for an existing Supabase project, specified by its unique reference ID (`ref`); this is a read-only operation.
Get project configRetrieve a project's consolidated effective database, pooler, Auth, Data API, Realtime, and Storage configuration.
Get Project Disk Autoscale ConfigGet disk autoscale configuration.
Get Project Function Combined StatsGet combined function statistics.
Get project logsRetrieves the unified logs stream for a Supabase project, including database, API, and edge function logs, for monitoring and debugging.
Get project metricsRetrieve a Supabase project's Prometheus/OpenMetrics exposition.
Get project PgBouncer configRetrieves the active PgBouncer configuration (PostgreSQL connection pooler) for a Supabase project, used for performance tuning, auditing, or getting the connection string.
Get project postgres configRetrieves the current read-only PostgreSQL database configuration for a specified Supabase project's `ref`, noting that some advanced or security-sensitive details might be omitted from the response.
Get project's PostgREST configRetrieves the PostgREST configuration for a specific Supabase project.
Get project's read-only mode statusRetrieves the read-only mode status for a specified Supabase project to check its operational state; this action does not change the read-only state.
Get project signing keysTool to list all signing keys for a Supabase project.
Get project Supavisor configurationRetrieves the Supavisor (connection pooler) configuration for a specified Supabase project, identified by its reference ID.
Get Project Upgrade EligibilityChecks a Supabase project's eligibility for an upgrade, verifying compatibility and identifying potential issues; this action does not perform the actual upgrade.
Get project upgrade statusRetrieves the latest status of a Supabase project's database upgrade for monitoring purposes; does not initiate or modify upgrades.
Get Project Usage Api CountGet project usage API counts.
Get Project Usage Request CountGet project usage API request counts.
Get Public Image HeadersGet public image transformation headers.
Get Public Object HeadersGet public object information headers.
Get Public Object InfoGet public object information.
Get Realtime ConfigGet Realtime configuration.
Get TUS resumable upload base optionsHandles OPTIONS request for TUS Resumable uploads to discover server capabilities.
Get TUS resumable upload optionsHandles OPTIONS request for TUS Resumable uploads to discover server capabilities.
Get Resumable Upload StatusGet resumable upload offset and metadata.
Get Resumable Upload Status SignedGet signed resumable upload offset and metadata.
Get Signed Image HeadersGet signed image transformation headers.
Get Signed Object HeadersGet headers for a presigned object retrieval.
Get project's auth configRetrieves a project's authentication configuration, including provider, MFA, email, SMS, JWT and security settings.
Get project's service health statusRetrieves the current health status for a Supabase project, for specified services or all services if the 'services' list is omitted.
Get a specific SQL snippetRetrieves a specific SQL snippet by its unique identifier.
Get a SSO provider by its UUIDRetrieves configuration details for a project's SAML Single Sign-On provider by UUID.
Get Storage BucketGet bucket details.
Get Storage Bucket HeadersGet bucket response headers.
Get Storage Bucket List HeadersGet bucket-list response headers.
Get Storage ConfigGet project Storage configuration.
Get Storage HealthCheck the Storage service health, distinct from Management API health.
Get Storage Health HeadersGet Storage service health response headers.
Get Storage Object HeadersRetrieve object information headers.
Get Storage Object InfoRetrieve object information.
Get Storage Object Info HeadersGet object information headers.
Get Table SchemasRetrieve column details, types, primary and unique constraints, and optionally foreign keys for multiple database tables.
OPTIONS for resumable upload signSend an OPTIONS request to the TUS resumable upload signing endpoint.
OPTIONS for resumable upload signSend an OPTIONS request to a TUS resumable upload signing endpoint for a specified path.
Insert Table RowsInsert rows or upsert on primary/UNIQUE keys in an exposed table or view.
Invite External Jit AccessInvite an external user for JIT database access.
Invoke Database FunctionInvoke a known exposed Postgres function with named JSON arguments.
Invoke Edge FunctionTool to invoke a deployed Supabase Edge Function over HTTPS.
Invoke Read Only FunctionInvoke a known exposed Postgres function using GET in a read-only transaction.
List Action RunsList one page of action runs for a project.
List all organizationsLists organizations associated with the authenticated Supabase account, returning their IDs, slugs, and names.
List all projectsLists Supabase projects for the authenticated user, including project ID, name, organization ID, region, status, database information, and creation time.
List project database backupsLists all database backups for a Supabase project, providing details on existing backups but not creating new ones or performing restores; availability may depend on plan and configuration.
List database branchesLists all database branches for a specified Supabase project, providing information about each branch's status, configuration, and metadata.
List all bucketsRetrieves a list of all storage buckets for a Supabase project, without returning bucket contents or access policies.
List all database branchesLists all database branches for a specified Supabase project, used for isolated development and testing of schema changes; ensure the project reference ID is valid.
List all functionsLists metadata for all Edge Functions in a Supabase project (specified by 'ref'), excluding function code or logs; the project must exist.
List Jit AccessList all user-to-role mappings for JIT access.
List migration historyRetrieves the list of applied database migration versions for a Supabase project.
List members of an organizationRetrieves all members of a Supabase organization, identified by its unique slug, including their user ID, username, email, role, and MFA status.
List Organization ProjectsList one page of projects for an organization.
List Project AddonsList billing addons and compute instance selections.
List Project Restore VersionsList available restore versions for a project.
List project secretsRetrieves all secrets (environment variables) for a Supabase project by its reference ID.
List all secretsRetrieves all secrets for a Supabase project using its reference ID; secret values in the response may be masked.
List SQL snippets for the logged in userRetrieves the first page of SQL snippets for the logged-in user, optionally filtered by Supabase project.
List all SSO providersLists all configured Single Sign-On (SSO) providers for a Supabase project, requiring the project reference ID (`ref`) of an existing project.
List Storage BucketsList Storage buckets through the data-plane API.
List Storage ObjectsSearch for objects under a prefix.
List Storage Objects V2Search for objects under a prefix using list v2.
List Database TablesLists tables and optionally views in Supabase database schemas, providing an overview of database structure.
Merge a database branchInitiates a merge of a database branch into its target database.
Modify Database DiskModify database disk configuration.
Move Storage ObjectMove an object.
Oauth Authorize Project ClaimInitiate OAuth authorization to claim a project.
Patch a migration[Beta] Patches an existing entry in the project's migration history, updating the name or rollback script.
Patch project network restrictionsUpdates project's network restrictions by incrementally adding or removing IPv4/IPv6 CIDR blocks.
Pause ProjectPause a project, making its services unavailable until it is restored.
Post Resumable UploadCreate a TUS upload through the wildcard creation route (an alias of base POST).
Post Resumable Upload SignedCreate a signed TUS upload through the wildcard creation route (an alias of base POST).
Purge Bucket CachePurge cache for a bucket or its transformations.
Purge Object CachePurge cache for an object or its transformations.
Purge Storage CachePurge cache for the tenant or tenant transformations.
Push a database branchPushes a database branch, applying migrations and changes to the specified branch.
Remove Project AddonRemove billing addons or revert compute sizing.
Render Authenticated ImageRender an authenticated image with transformations.
Render Public ImageRender a public image with transformations.
Render Signed ImageRender a signed image with transformations.
Replace Bucket LifecycleReplace bucket lifecycle configuration.
Reset a database branchResets an existing Supabase database branch, identified by `branch_id`, to its initial clean state, irreversibly deleting all its current data and schema changes.
Restart ProjectRestart a project, temporarily interrupting its services.
Restore BranchRestore a scheduled branch deletion.
Restore database PITR backupRestores a Supabase project's database to a specific Unix timestamp using Point-in-Time Recovery (PITR), overwriting the current state; requires a paid plan with PITR and physical backups enabled.
Restore ProjectRestore the given project.
Rollback MigrationsRollback database migrations and remove them from history.
Execute read-only database queryRun a read-only SQL query against a Supabase project as supabase_read_only_user.
Select From TableSelect rows from a Supabase/PostgREST table or view, with column selection, filtering, sorting, and pagination.
Shutdown RealtimeShut down the project Realtime service connections, disconnecting active clients.
Terminate Resumable UploadTerminate a TUS resumable upload.
Terminate Resumable Upload SignedTerminate a signed resumable upload.
Update Action Run StatusUpdate the status of an action run.
Update a functionUpdates an existing Supabase Edge Function's properties, including its name, slug, source code, JWT settings, and import map, using its project reference and function slug.
Update API keyUpdates an existing Supabase project API key's name, description, or JWT template without regenerating the key.
Update Backup ScheduleUpdate the project's backup schedule.
Update branch configurationUpdates the configuration of a Supabase database branch, allowing modification of its name, associated Git branch, notification URL, persistence settings, and status.
Update database branch configUpdates a Supabase database branch's configuration, including its name, associated Git branch, persistence, and status.
Update database passwordUpdates the database password for a Supabase project.
Bulk update functionsBulk updates Edge Functions in a Supabase project with configurations such as status and version.
Update Jit AccessUpdate a user mapping for JIT access.
Update JIT access config[Beta] Update a Supabase project's just-in-time (JIT) access configuration.
Update pgsodium root keyUpdates a Supabase project's pgsodium root encryption key.
Update a projectUpdates a Supabase project's configuration (currently supports updating the project name).
Update project's auth configUpdate Supabase project Auth configuration via the Management API.
Update project's custom hostname configurationUpdates the custom hostname for a Supabase project, requiring subsequent DNS changes for SSL certificate issuance and domain ownership.
Update project legacy API keysDeprecated by the provider; no sunset date or replacement is announced.
Update project's postgres configUpdates specified PostgreSQL configuration parameters for an existing Supabase project (`ref`) to optimize database performance; note that unspecified parameters remain unchanged, and caution is advised as incorrect settings can impact stability or require a restart.
Update project's PostgREST configUpdates PostgREST configuration settings (e.
Update database pooler configUpdates Supavisor (database pooler) configuration, including default pool size and pool mode, for an existing Supabase project identified by its reference.
Update Realtime ConfigUpdate Realtime configuration.
Update SSL enforcement configUpdates the SSL enforcement configuration (enable/disable) for a specified Supabase project's database.
Update an SSO provider by its UUIDUpdates an existing SSO provider's SAML metadata, associated email domains, or attribute mappings for a Supabase project, identified by `ref` and `provider_id`.
Update Storage BucketUpdate bucket properties.
Update Storage ConfigUpdate project Storage configuration.
Update Storage ObjectUpdate the object at an existing key.
Update Table RowsUpdate matching rows in an exposed Supabase table or updatable view.
Upload Signed ObjectUpload an object using a presigned URL.
Upload Storage ObjectUpload a new object.
Upsert migrationTool to upsert a database migration without applying it.
Reverify custom hostnameRe-verifies DNS and SSL configurations for an existing custom hostname associated with a Supabase project.