Supabase API Operations Reference

payments

121 operations

ActionSUPABASE_BETA_ACTIVATE_VANITY_SUBDOMAIN

Activate vanity subdomain for project

Activates a vanity subdomain for the specified Supabase project (e.g., 'my-brand.supabase.co').

2 input

ActionSUPABASE_APPLY_A_MIGRATION

Apply a database migration

Tool to apply database migrations to a Supabase project.

5 input

ActionSUPABASE_BETA_AUTHORIZE_USER_THROUGH_OAUTH

Authorize user through OAuth

Generates a Supabase OAuth 2.0 authorization URL for user redirection.

8 input

ActionSUPABASE_BETA_ACTIVATE_CUSTOM_HOSTNAME

Beta activate custom hostname for project

Activates a previously configured custom hostname for a Supabase project, assuming DNS settings are verified externally.

1 input

ActionSUPABASE_BETA_GET_PROJECT_CUSTOM_HOSTNAME_CONFIG

Beta get project's custom hostname config

Retrieves a Supabase project's custom hostname configuration, including its status, SSL certificate, and ownership verification, noting that availability may…

1 input

ActionSUPABASE_BETA_UPDATE_PROJECT_NETWORK_RESTRICTIONS

Beta update project network restrictions

Updates and applies network access restrictions (IPv4/IPv6 CIDR lists) for a Supabase project, which may terminate existing connections not matching the new…

3 input

ActionSUPABASE_CREATE_BULK_SECRETS

Bulk create secrets

Tool to bulk create secrets for a Supabase project.

2 input

ActionSUPABASE_DELETE_SECRETS

Bulk delete secrets

Tool to bulk delete secrets from a Supabase project.

2 input

ActionSUPABASE_UPDATE_FUNCTIONS

Bulk update functions

Tool to bulk update Edge Functions in a Supabase project.

2 input

ActionSUPABASE_BETA_CHECK_VANITY_SUBDOMAIN_AVAILABILITY

Check vanity subdomain availability

Checks if a specific vanity subdomain is available for a Supabase project; this action does not reserve or assign the subdomain.

2 input

ActionSUPABASE_COUNT_ACTION_RUNS

Count action runs

Counts the number of action runs for a Supabase project using a HEAD request.

1 input

ActionSUPABASE_CREATE_LOGIN_ROLE

Create CLI login role

Creates a temporary CLI login role for database access with specified permissions; use when setting up CLI authentication for development or administrative…

2 input

ActionSUPABASE_CREATE_SSO_PROVIDER

Create SSO provider configuration

Creates a new SAML 2.0 Single Sign-On (SSO) provider for a Supabase project, requiring either metadataxml or metadataurl for SAML IdP configuration.

6 input

ActionSUPABASE_CREATE_DATABASE_BRANCH

Create a database branch

Creates a new, isolated database branch from an existing Supabase project (identified by ref), useful for setting up separate environments like development or…

8 input

ActionSUPABASE_CREATE_FUNCTION

Create a function

Creates a new serverless Edge Function for a Supabase project (identified by ref), requiring valid JavaScript/TypeScript in body and a project-unique slug…

8 input

ActionSUPABASE_CREATE_THIRD_PARTY_AUTH_INTEGRATION

Create a new third-party auth integration

Call this to add a new third-party authentication method (OIDC or JWKS) to a Supabase project for integrating external identity providers (e.g., for SSO); the…

3 input

ActionSUPABASE_CREATE_ORGANIZATION

Create an organization

Creates a new Supabase organization, which serves as a top-level container for projects, billing, and team access.

1 input

ActionSUPABASE_CREATE_A_PROJECT

Create new project

Creates a new Supabase project, requiring a unique name (no dots) within the organization; project creation is asynchronous.

10 input

ActionSUPABASE_ALPHA_CREATE_API_KEY

Create project api key

Creates a 'publishable' or 'secret' API key for an existing Supabase project, optionally with a description; 'secret' keys can have customized JWT templates.

4 input

ActionSUPABASE_CREATE_PROJECT_SIGNING_KEY

Create project signing key

Create a new signing key for JWT authentication in a Supabase project.

3 input

ActionSUPABASE_DELETE_LOGIN_ROLES

Delete CLI login roles

[Beta] Deletes existing login roles used by the Supabase CLI for the specified project.

1 input

ActionSUPABASE_ALPHA_DELETE_API_KEY

Delete an API key from the project

Permanently deletes a specific API key (identified by id) from a Supabase project (identified by ref), revoking its access.

2 input

ActionSUPABASE_DELETE_FUNCTION

Delete an edge function by slug

Permanently deletes a specific Edge Function (by functionslug) from a Supabase project (by ref); this action is irreversible and requires prior existence of…

2 input

ActionSUPABASE_DELETE_DATABASE_BRANCH

Delete branch by id

Permanently and irreversibly deletes a specific, non-default database branch by its branchid, without affecting other branches.

1 input

ActionSUPABASE_DELETE_CUSTOM_HOSTNAME_CONFIG

Delete custom hostname config

Deletes an active custom hostname configuration for the project identified by ref, reverting to the default Supabase-provided hostname; this action immediately…

1 input

ActionSUPABASE_DELETE_PROJECT

Delete project by ref

Permanently and irreversibly deletes a Supabase project, identified by its unique ref ID, resulting in complete data loss.

1 input

ActionSUPABASE_ALPHA_DELETE_THIRD_PARTY_AUTH_INTEGRATION

Delete third party auth config

Removes a third-party authentication provider (e.g., Google, GitHub) from a Supabase project's configuration; this immediately prevents users from logging in…

2 input

ActionSUPABASE_DELETE_PROJECT_VANITY_SUBDOMAIN

Delete vanity subdomain for project

Permanently and irreversibly deletes an active vanity subdomain configuration for the specified Supabase project, reverting it to its default Supabase URL.

1 input

ActionSUPABASE_DEPLOY_FUNCTION

Deploy function

Deploys Edge Functions to a Supabase project using multipart upload.

6 input

ActionSUPABASE_DISABLE_PREVIEW_BRANCHING

Disable preview branching

Disables the preview branching feature for an existing Supabase project, identified by its unique reference ID (ref).

1 input

ActionSUPABASE_DISABLE_PROJECT_READONLY

Disable project readonly mode

Temporarily disables a Supabase project's read-only mode for 15 minutes to allow write operations (e.g., for maintenance or critical updates), after which it…

1 input

ActionSUPABASE_BETA_ENABLE_DATABASE_WEBHOOKS

Enable project database webhooks

Enables database webhooks for the Supabase project ref, triggering real-time notifications for INSERT, UPDATE, or DELETE events.

1 input

ActionSUPABASE_EXCHANGE_OAUTH_TOKEN

Exchange auth code for access and refresh token

(Beta) Implements the OAuth 2.0 token endpoint to exchange an authorization code or refresh token for access/refresh tokens, based on granttype.

7 input

ActionSUPABASE_BETA_RUN_SQL_QUERY

Execute project database query

Executes a given SQL query against the project's database; use for advanced data operations or when standard API endpoints are insufficient, ensuring queries…

3 input

ActionSUPABASE_RUN_READ_ONLY_QUERY

Execute read-only database query

[Beta] Run a SQL query as supabasereadonlyuser.

3 input

ActionSUPABASE_GENERATE_TYPESCRIPT_TYPES

Generate TypeScript types

Generates and retrieves TypeScript types from a Supabase project's database; any schemas specified in includedschemas must exist in the project.

2 input

ActionSUPABASE_GET_HEALTH

Get API Health Status

Tool to check the health status of the Supabase API.

ActionSUPABASE_GET_AVAILABLE_REGIONS

Get Available Regions

Tool to get the list of available regions for creating a new Supabase project.

3 input

ActionSUPABASE_GET_DATABASE_METADATA

Get Database Metadata

Gets database metadata for the given project.

1 input

ActionSUPABASE_GET_JIT_ACCESS_CONFIG

Get JIT access config

[Beta] Retrieves the project's just-in-time (JIT) access configuration, including user roles and their expiration settings.

1 input

ActionSUPABASE_GET_PROJECT_UPGRADE_ELIGIBILITY

Get Project Upgrade Eligibility

Checks a Supabase project's eligibility for an upgrade, verifying compatibility and identifying potential issues; this action does not perform the actual…

1 input

ActionSUPABASE_GET_SECURITY_ADVISORS

Get Security Advisors

Retrieves security advisor findings and recommendations for a Supabase project.

2 input

ActionSUPABASE_GET_RESUMABLE_UPLOAD_BASE_OPTIONS

Get TUS resumable upload base options

Handles OPTIONS request for TUS Resumable uploads to discover server capabilities.

ActionSUPABASE_GET_RESUMABLE_UPLOAD_OPTIONS

Get TUS resumable upload options

Handles OPTIONS request for TUS Resumable uploads to discover server capabilities.

1 input

ActionSUPABASE_GET_TABLE_SCHEMAS

Get Table Schemas

Retrieves column details, types, and constraints for multiple database tables to help debug schema issues and write accurate SQL queries.

5 input

ActionSUPABASE_GET_SSO_PROVIDER

Get a SSO provider by its UUID

Retrieves the configuration details for a specific Single Sign-On (SSO) provider (e.g., SAML, Google, GitHub, Azure AD), identified by its UUID, within a…

2 input

ActionSUPABASE_GET_BRANCH

Get a database branch

Retrieves detailed information about a specific database branch by its name and project reference.

2 input

ActionSUPABASE_GET_MIGRATION

Get a migration

Retrieves a specific database migration entry from the migration history using its version identifier.

2 input

ActionSUPABASE_GET_SQL_SNIPPET

Get a specific SQL snippet

Retrieves a specific SQL snippet by its unique identifier.

1 input

ActionSUPABASE_ALPHA_GET_THIRD_PARTY_INTEGRATION

Get a third-party integration

Retrieves the detailed configuration for a specific third-party authentication (TPA) provider, identified by tpaid, within an existing Supabase project…

2 input

ActionSUPABASE_GET_ACTION_RUN_LOGS

Get action run logs

Retrieves the execution logs for a specific action run by its ID.

2 input

ActionSUPABASE_GET_ACTION_RUN

Get action run status

Retrieves the status and details of a specific action run, including its steps, timestamps, and configuration.

2 input

ActionSUPABASE_BETA_GET_VANITY_SUBDOMAIN_CONFIG

Get current vanity subdomain config

Fetches the current vanity subdomain configuration, including its status and custom domain name, for a Supabase project identified by its reference ID.

1 input

ActionSUPABASE_GET_DATABASE_BRANCH_CONFIG

Get database branch config

Retrieves the read-only configuration and status for a Supabase database branch, typically for monitoring or verifying its settings.

1 input

ActionSUPABASE_GET_ORGANIZATION

Get information about an organization

Fetches comprehensive details for a specific Supabase organization using its unique slug.

1 input

ActionSUPABASE_GET_LEGACY_SIGNING_KEY

Get legacy signing key

Retrieves the signing key information for the JWT secret imported as signing key for this project.

1 input

ActionSUPABASE_GET_PERFORMANCE_ADVISORS

Get performance advisors

Retrieves project performance advisors for a Supabase project.

1 input

ActionSUPABASE_GET_PROJECT

Get project

Retrieves detailed information about a specific Supabase project by its unique reference ID.

1 input

ActionSUPABASE_GET_PROJECT_API_KEY

Get project API key

Retrieves details of a specific API key for a Supabase project by its UUID.

3 input

ActionSUPABASE_GET_PROJECT_API_KEYS

Get project API keys

Retrieves all API keys for an existing Supabase project, specified by its unique reference ID (ref); this is a read-only operation.

2 input

ActionSUPABASE_GET_PROJECT_PGBOUNCER_CONFIG

Get project PgBouncer config

Retrieves the active PgBouncer configuration (PostgreSQL connection pooler) for a Supabase project, used for performance tuning, auditing, or getting the…

1 input

ActionSUPABASE_BETA_GET_PROJECT_SSL_ENFORCEMENT_CONFIG

Get project SSL enforcement configuration

Retrieves the SSL enforcement configuration for a specified Supabase project, indicating if SSL connections are mandated for its database.

1 input

ActionSUPABASE_GET_PROJECT_SUPAVISOR_CONFIG

Get project Supavisor configuration

Retrieves the Supavisor (connection pooler) configuration for a specified Supabase project, identified by its reference ID.

1 input

ActionSUPABASE_GET_PROJECT_LEGACY_API_KEYS

Get project legacy API keys status

Checks whether JWT-based legacy API keys (anon, servicerole) are enabled for a Supabase project.

1 input

ActionSUPABASE_GET_PROJECT_LOGS

Get project logs

Retrieves analytics logs for a Supabase project.

4 input

ActionSUPABASE_BETA_GET_PROJECT_NETWORK_RESTRICTIONS

Get project network restrictions

Retrieves the network restriction settings (IP allowlists) for a Supabase project.

1 input

ActionSUPABASE_BETA_GET_PROJECT_PGSODIUM_CONFIG

Get project pgsodium config

Retrieves the PGSodium configuration, including the root encryption key, for an existing Supabase project identified by its ref.

1 input

ActionSUPABASE_GET_PROJECT_POSTGRES_CONFIG

Get project postgres config

Retrieves the current read-only PostgreSQL database configuration for a specified Supabase project's ref, noting that some advanced or security-sensitive…

1 input

ActionSUPABASE_GET_PROJECT_SIGNING_KEYS

Get project signing keys

Tool to list all signing keys for a Supabase project.

1 input

ActionSUPABASE_GET_PROJECT_UPGRADE_STATUS

Get project upgrade status

Retrieves the latest status of a Supabase project's database upgrade for monitoring purposes; does not initiate or modify upgrades.

1 input

ActionSUPABASE_GET_PROJECT_POSTGREST_CONFIG

Get project's PostgREST config

Retrieves the PostgREST configuration for a specific Supabase project.

1 input

ActionSUPABASE_GETS_PROJECT_S_AUTH_CONFIG

Get project's auth config

Retrieves the project's complete read-only authentication configuration, detailing all settings (e.g., providers, MFA, email/SMS, JWT, security policies) but…

1 input

ActionSUPABASE_GET_PROJECT_READONLY_MODE_STATUS

Get project's read-only mode status

Retrieves the read-only mode status for a specified Supabase project to check its operational state; this action does not change the read-only state.

1 input

ActionSUPABASE_GETS_PROJECT_S_SERVICE_HEALTH_STATUS

Get project's service health status

Retrieves the current health status for a Supabase project, for specified services or all services if the 'services' list is omitted.

2 input

ActionSUPABASE_INVOKE_EDGE_FUNCTION

Invoke Edge Function

Tool to invoke a deployed Supabase Edge Function over HTTPS.

7 input

ActionSUPABASE_LIST_TABLES

List Database Tables

Lists all tables and views in specified database schemas, providing a quick overview of database structure to help identify available tables before fetching…

5 input

ActionSUPABASE_LIST_SQL_SNIPPETS

List SQL snippets for the logged in user

Retrieves a list of SQL snippets for the logged-in user, optionally filtered by a specific Supabase project if projectref is provided.

1 input

ActionSUPABASE_LIST_SSO_PROVIDERS

List all SSO providers

Lists all configured Single Sign-On (SSO) providers for a Supabase project, requiring the project reference ID (ref) of an existing project.

1 input

ActionSUPABASE_LIST_BUCKETS

List all buckets

Retrieves a list of all storage buckets for a Supabase project, without returning bucket contents or access policies.

1 input

ActionSUPABASE_LIST_DATABASE_BRANCHES

List all database branches

Lists all database branches for a specified Supabase project, used for isolated development and testing of schema changes; ensure the project reference ID is…

1 input

ActionSUPABASE_LIST_FUNCTIONS

List all functions

Lists metadata for all Edge Functions in a Supabase project (specified by 'ref'), excluding function code or logs; the project must exist.

1 input

ActionSUPABASE_LIST_ALL_ORGANIZATIONS

List all organizations

Lists all organizations (ID and name only) associated with the Supabase account, excluding project details within these organizations.

ActionSUPABASE_LIST_ALL_PROJECTS

List all projects

Retrieves a list of all Supabase projects, including their ID, name, region, and status, for the authenticated user.

ActionSUPABASE_LIST_SECRETS

List all secrets

Retrieves all secrets for a Supabase project using its reference ID; secret values in the response may be masked.

1 input

ActionSUPABASE_LIST_ORGANIZATION_MEMBERS

List members of an organization

Retrieves all members of a Supabase organization, identified by its unique slug, including their user ID, username, email, role, and MFA status.

1 input

ActionSUPABASE_LIST_MIGRATION_HISTORY

List migration history

Retrieves the list of applied database migration versions for a Supabase project.

1 input

ActionSUPABASE_LIST_BACKUPS

List project database backups

Lists all database backups for a Supabase project, providing details on existing backups but not creating new ones or performing restores; availability may…

1 input

ActionSUPABASE_ALPHA_LIST_THIRD_PARTY_AUTH_INTEGRATIONS

List third-party auth integrations for project

Lists all configured third-party authentication provider integrations for an existing Supabase project (using its ref), suitable for read-only auditing or…

1 input

ActionSUPABASE_HANDLE_RESUMABLE_UPLOAD_SIGN_OPTIONS

OPTIONS for resumable upload sign

Handles CORS preflight OPTIONS request for TUS resumable upload signing.

ActionSUPABASE_HANDLE_RESUMABLE_UPLOAD_SIGN_OPTIONS_WITH_ID

OPTIONS for resumable upload sign

Handles CORS preflight OPTIONS request for TUS resumable upload signing endpoints.

1 input

ActionSUPABASE_PATCH_MIGRATION

Patch a migration

[Beta] Patches an existing entry in the project's migration history, updating the name or rollback script.

4 input

ActionSUPABASE_PATCH_NETWORK_RESTRICTIONS

Patch project network restrictions

Updates project's network restrictions by incrementally adding or removing IPv4/IPv6 CIDR blocks.

3 input

ActionSUPABASE_PUSH_BRANCH

Push a database branch

Pushes a database branch, applying migrations and changes to the specified branch.

2 input

ActionSUPABASE_DELETE_SSO_PROVIDER

Remove an SSO provider

Deletes a specific SSO provider by its ID (providerid) from a Supabase project (ref), which disables it and returns its details; ensure this action will not…

2 input

ActionSUPABASE_BETA_REMOVE_NETWORK_BANS

Remove project network bans

Removes specified IPv4 addresses from a Supabase project's network ban list, granting immediate access; IPs not currently banned are ignored.

2 input

ActionSUPABASE_BETA_REMOVE_READ_REPLICA

Remove read replica

Remove a read replica from a Supabase project (Pro plan or higher required).

2 input

ActionSUPABASE_RESET_DATABASE_BRANCH

Reset a database branch

Resets an existing Supabase database branch, identified by branchid, to its initial clean state, irreversibly deleting all its current data and schema changes.

1 input

ActionSUPABASE_RESTORE_PITR_BACKUP

Restore database PITR backup

Restores a Supabase project's database to a specific Unix timestamp using Point-in-Time Recovery (PITR), overwriting the current state; requires a paid plan…

2 input

ActionSUPABASE_GET_FUNCTION

Retrieve a function

Retrieves detailed information, metadata, configuration, and status for a specific Edge Function using its project reference ID and function slug.

2 input

ActionSUPABASE_GET_FUNCTION_BODY

Retrieve a function body

Retrieves the source code (body) for a specified serverless Edge Function using its project reference and function slug; this is a read-only operation that…

2 input

ActionSUPABASE_BETA_GET_PROJECT_NETWORK_BANS

Retrieve network bans for project

Retrieves the list of banned IPv4 addresses for a Supabase project using its unique project reference string; this is a read-only operation.

1 input

ActionSUPABASE_VERIFY_CUSTOM_HOSTNAME_DNS

Reverify custom hostname

Re-verifies DNS and SSL configurations for an existing custom hostname associated with a Supabase project.

1 input

ActionSUPABASE_SELECT_FROM_TABLE

Select From Table

Tool to select rows from a Supabase/PostgREST table.

7 input

ActionSUPABASE_BETA_CREATE_READ_REPLICA

Setup read replica for project

Provisions a read-only replica for a Supabase project in a specified, Supabase-supported AWS region to enhance read performance and reduce latency.

2 input

ActionSUPABASE_UPDATE_JIT_ACCESS_CONFIG

Update JIT access config

[Beta] Update a Supabase project's just-in-time (JIT) access configuration.

2 input

ActionSUPABASE_UPDATE_SSL_ENFORCEMENT_CONFIG

Update SSL enforcement config

Updates the SSL enforcement configuration (enable/disable) for a specified Supabase project's database.

2 input

ActionSUPABASE_UPDATE_A_FUNCTION

Update a function

Updates an existing Supabase Edge Function's properties (like name, slug, source code, JWT settings, import map) identified by project ref and functionslug,…

9 input

ActionSUPABASE_UPDATE_PROJECT

Update a project

Updates a Supabase project's configuration (currently supports updating the project name).

2 input

ActionSUPABASE_ALPHA_UPDATE_API_KEY

Update an API key for the project

Updates an existing Supabase project API key's description and/or secretjwttemplate (which defines its role); does not regenerate the key string.

3 input

ActionSUPABASE_UPDATE_SSO_PROVIDER

Update an SSO provider by its UUID

Updates an existing SSO provider's SAML metadata, associated email domains, or attribute mappings for a Supabase project, identified by ref and providerid.

6 input

ActionSUPABASE_UPDATE_DATABASE_BRANCH_CONFIG

Update database branch config

Updates the configuration of a Supabase database branch, allowing modification of its name, associated Git branch, reset-on-push behavior, persistence, and…

6 input

ActionSUPABASE_UPDATE_DATABASE_PASSWORD

Update database password

Updates the database password for a Supabase project.

2 input

ActionSUPABASE_UPDATE_PROJECT_SUPAVISOR_CONFIG

Update database pooler config

Updates the Supavisor (database pooler) configuration, such as defaultpoolsize, for an existing Supabase project identified by ref; the poolmode parameter in…

3 input

ActionSUPABASE_UPDATE_PGSODIUM_CONFIG

Update pgsodium root key

Critically updates or initializes a Supabase project's pgsodium root encryption key for security setup or key rotation, requiring secure backup of the new key…

2 input

ActionSUPABASE_UPDATE_PROJECT_LEGACY_API_KEYS

Update project legacy API keys

Tool to disable or re-enable JWT-based legacy API keys (anon, servicerole) for a Supabase project.

2 input

ActionSUPABASE_UPDATE_PROJECT_POSTGREST_CONFIG

Update project's PostgREST config

Updates PostgREST configuration settings (e.g., maxrows, dbpool, dbschema, dbextrasearchpath) for a Supabase project to fine-tune API performance, data…

5 input

ActionSUPABASE_UPDATE_PROJECT_AUTH_CONFIG

Update project's auth config

Update Supabase project Auth configuration via the Management API.

60 input

ActionSUPABASE_UPDATE_PROJECT_CUSTOM_HOSTNAME

Update project's custom hostname configuration

Updates the custom hostname for a Supabase project, requiring subsequent DNS changes to a user-controlled domain for SSL certificate issuance and domain…

2 input

ActionSUPABASE_UPDATE_PROJECT_POSTGRES_CONFIG

Update project's postgres config

Updates specified PostgreSQL configuration parameters for an existing Supabase project (ref) to optimize database performance; note that unspecified parameters…

18 input

ActionSUPABASE_BETA_UPGRADE_PROJECT_POSTGRES_VERSION

Upgrade the project's PostgreSQL version

Initiates an asynchronous upgrade of a Supabase project's PostgreSQL database to a specified targetversion from a selected releasechannel, returning a…

3 input

ActionSUPABASE_UPSERT_MIGRATION

Upsert migration

Tool to upsert a database migration without applying it.

5 input