Reference

Create project api key

Generate API keys for your Supabase project to securely authenticate and manage access to your backend services and data.

Delete an API key from the project

Permanently remove an API key from your Supabase project to revoke its access and prevent unauthorized use. Use this when a key is compromised, no longer needed, or associated with a decommissioned service.

Update an API key for the project

Modify the settings of an existing Supabase API key by updating its description or JWT role configuration, without regenerating the actual key string.

Count action runs

Retrieves the total count of action runs in your Supabase project without loading the full dataset, helping you monitor automation activity and workflow execution volume.

Get action run logs

Retrieve detailed execution logs for a specific action run to see what happened, how it performed, and any errors that occurred. This helps you troubleshoot failed automations and understand why actions didn't work as expected.

Get action run status

Retrieve the current status and execution details of a specific action run, including progress tracking and configuration information. Use this to monitor workflow execution and troubleshoot any issues with automated processes.

Authorize user through OAuth

Generates an OAuth 2.0 authorization URL that redirects users to securely log in through third-party providers like Google or GitHub. This enables you to offer seamless social login options without managing passwords directly.

Create a new third-party auth integration

Set up external login methods for your Supabase project by connecting identity providers, allowing your users to sign in with their existing accounts from other services.

Create SSO provider configuration

Set up SAML-based single sign-on for your Supabase application so users can authenticate using their organization's identity provider instead of creating separate accounts.

Delete third party auth config

Remove a third-party login option (like Google or GitHub) from your Supabase project, immediately preventing users from signing in through that method.

Exchange auth code for access and refresh token

Converts OAuth authorization codes or refresh tokens into access tokens that allow your application to securely authenticate users and access their data on their behalf.

Get a third-party integration

Retrieve the complete configuration details for a third-party authentication provider in your Supabase project, allowing you to verify settings and troubleshoot integration issues.

List third-party auth integrations for project

Retrieve a list of all third-party authentication providers currently configured for your Supabase project, allowing you to audit and verify your active login methods.

Remove an SSO provider

Disables a single sign-on provider from your Supabase project, removing that authentication method for your users. Use this when you need to discontinue a login option or switch to a different authentication provider.

Create a database branch

Creates an isolated copy of your database that you can modify independently, perfect for testing new features or experimenting without affecting your live data.

Delete branch by id

Removes a database branch from your Supabase project to clean up unused development or staging environments and free up resources.

Disable preview branching

Turn off the preview branching feature on your Supabase project to simplify your database management and reduce complexity. This is useful when you no longer need isolated testing environments or want to streamline your development workflow.

Execute project database query

Run custom SQL queries directly against your Supabase database for advanced data operations that go beyond standard endpoints. This lets you perform complex data retrievals, updates, or analysis with full control over your database.

Enable project database webhooks

Activates real-time event notifications for your database, sending instant alerts whenever data is added, modified, or deleted so you can trigger automated workflows in response.

Remove read replica

Removes a read replica database from your Supabase project, allowing you to eliminate duplicate databases you no longer need and reduce infrastructure costs.

Setup read replica for project

Creates a read-only copy of your database in a different geographic region to speed up data access for users in that location and improve overall application performance.

Upgrade the project's PostgreSQL version

Upgrade your Supabase project's PostgreSQL database to a newer version to access performance improvements, security patches, and new database features. The upgrade runs in the background and can be monitored using a tracking ID.

Generate TypeScript types

Automatically generates TypeScript type definitions that match your Supabase database schema, ensuring your code stays synchronized with database changes. This saves development time and reduces type-related bugs when building applications against your database.

Activate vanity subdomain for project

Activate a custom branded subdomain for your Supabase project to give your authentication services a professional, branded appearance instead of using the generic project URL.

Beta activate custom hostname for project

Enables a custom domain name for your Supabase project after DNS verification is complete, allowing you to serve your application under your own branded domain instead of Supabase's default domain.

Beta get project's custom hostname config

Retrieve your Supabase project's custom hostname configuration to verify SSL certificate status, domain ownership, and current deployment setup.

Check vanity subdomain availability

Verify whether a custom subdomain name is available for your Supabase project before committing to it. This helps you plan your project's branding and ensure your preferred domain isn't already taken.

Delete custom hostname config

Remove a custom domain from your Supabase project and revert to the default Supabase hostname, which immediately stops the custom domain from working until your DNS and application settings are updated.

Delete vanity subdomain for project

Removes a custom vanity subdomain from a Supabase project, reverting the project back to using Supabase's default URL. Use this when you no longer need the branded domain or want to simplify your infrastructure.

Get current vanity subdomain config

Retrieves the current vanity subdomain settings for your Supabase project, including whether it's active and what custom domain name is configured. Use this to verify your project's custom domain setup and troubleshoot connectivity issues.

Create a function

Deploy custom serverless functions to handle business logic without managing infrastructure, enabling you to build APIs, automate workflows, and process data in real-time for your applications.

Delete an edge function by slug

Remove an Edge Function from your Supabase project when it's no longer needed, freeing up resources and cleaning up your infrastructure.

Deploy function

Deploy serverless functions to your Supabase project to add custom backend logic without managing infrastructure. This enables you to build and run code directly in the cloud for handling tasks like payments, notifications, and data processing.

Get Available Regions

Retrieves the list of geographic regions where you can deploy a new Supabase project, helping you choose the best location for your database based on performance and user proximity.

Apply a database migration

Executes database schema changes and updates to your Supabase project by applying tracked migrations, such as creating tables, modifying columns, or restructuring your database.

Create an organization

Sets up a new Supabase organization to manage your projects, billing, and team members in one centralized workspace. Use this when you're ready to organize multiple database projects or establish a dedicated billing entity.

Create new project

Provisions a new Supabase backend project with a unique name within your organization, enabling you to set up a new database and API infrastructure for your application.

Delete project by ref

Permanently remove a Supabase project and all its associated data by its reference ID. Use this when you no longer need a project and want to completely clean up your infrastructure.

Disable project readonly mode

Temporarily unlock your Supabase project from read-only mode for 15 minutes to perform urgent write operations like database updates or migrations, after which it automatically reverts to read-only for data protection.

Bulk create secrets

Create multiple secret credentials for your Supabase project in one operation, enabling you to securely store API keys, database passwords, and other sensitive configuration data all at once.

Bulk delete secrets

Remove multiple API keys, passwords, or sensitive credentials from your Supabase project in a single operation. Use this when cleaning up outdated secrets or revoking access across multiple integrations at once.

Beta update project network restrictions

Control who can access your Supabase project by setting up network restrictions based on IP addresses, ensuring only trusted networks can connect to your database and APIs.

Create CLI login role

Set up temporary database access credentials for your development team or administrative tools that need to manage your database from the command line.

Create project signing key

Generate a new signing key for securing JWT token authentication in your Supabase project, enabling you to control and rotate credentials for API access.

Delete CLI login roles

Remove CLI authentication roles that were previously set up for Supabase project access, allowing you to revoke outdated or unnecessary command-line login credentials.

Get project network restrictions

Retrieve the current IP allowlist and network security settings for your Supabase project to verify which IP addresses can access your database.

Get project pgsodium config

Retrieve the encryption key configuration for your Supabase project, enabling you to manage how sensitive data is encrypted and secured at the database level.

Get project SSL enforcement configuration

Check whether your database requires SSL connections, helping you verify your project's security settings and connection requirements.

Remove project network bans

Unblock specific IP addresses from accessing your Supabase project, allowing previously restricted users or services to reconnect immediately. Use this when you need to grant access to a location or device that was previously blocked.

Retrieve network bans for project

View all IPv4 addresses that have been blocked from accessing your Supabase project, helping you monitor and manage security threats.

Bulk update functions

Tool to bulk update Edge Functions in a Supabase project.

Execute read-only database query

[Beta] Run a SQL query as supabasereadonlyuser.

Get a database branch

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

Get a migration

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

Get a specific SQL snippet

Retrieves a specific SQL snippet by its unique identifier.

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…

Get API Health Status

Tool to check the health status of the Supabase API.

Get database branch config

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

Get Database Metadata

Gets database metadata for the given project.

Get information about an organization

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

Get JIT access config

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

Get legacy signing key

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

Get performance advisors

Retrieves project performance advisors for a Supabase project.

Get project

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

Get project API key

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

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.

Get project legacy API keys status

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

Get project logs

Retrieves analytics logs for a Supabase project.

Get project PgBouncer config

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

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…

Get project signing keys

Tool to list all signing keys for a Supabase project.

Get project Supavisor configuration

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

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…

Get project upgrade status

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

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…

Get project's PostgREST config

Retrieves the PostgREST configuration for a specific Supabase project.

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.

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.

Get Security Advisors

Retrieves security advisor findings and recommendations for a Supabase project.

Get Table Schemas

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

Get TUS resumable upload base options

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

Get TUS resumable upload options

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

Invoke Edge Function

Tool to invoke a deployed Supabase Edge Function over HTTPS.

List all buckets

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

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…

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.

List all organizations

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

List all projects

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

List all secrets

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

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.

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…

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.

List migration history

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

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…

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.

OPTIONS for resumable upload sign

Handles CORS preflight OPTIONS request for TUS resumable upload signing.

OPTIONS for resumable upload sign

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

Patch a migration

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

Patch project network restrictions

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

Push a database branch

Pushes a database branch, applying migrations and changes to the specified 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.

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…

Retrieve a function

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

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…

Reverify custom hostname

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

Select From Table

Tool to select rows from a Supabase/PostgREST table.

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,…

Update a project

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

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.

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…

Update database password

Updates the database password for a Supabase project.

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…

Update JIT access config

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

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…

Update project legacy API keys

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

Update project's auth config

Update Supabase project Auth configuration via the Management API.

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…

Update project's postgres config

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

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…

Update SSL enforcement config

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

Upsert migration

Tool to upsert a database migration without applying it.