- Category: developer tools
- Auth: OAUTH2, API_KEY
- Composio-managed OAuth available? Yes
- Tools: 235
- Triggers: 0
- Slug:
SUPABASE - Version: 20261103_00
Frequently Asked Questions
Limit Supabase scopes in the user's OAuth app, not through Composio's default app
Limit Supabase scopes in the user's OAuth app, not through Composio's default app
Tools
Accept Invite External Jit Access
Accept Invite External Jit Access
Create project api key
Create project api key
SUPABASE_ALPHA_CREATE_API_KEYCreates a publishable or secret API key for an existing Supabase project, optionally with a description.Input Parameters
Output
Delete an API key from the project
Delete an API key from the project
Delete third party auth config
Delete third party auth config
SUPABASE_ALPHA_DELETE_THIRD_PARTY_AUTH_INTEGRATIONRemoves a third-party authentication provider (e.g., Google, GitHub) from a Supabase project’s configuration; this immediately prevents users from logging in via that method.Input Parameters
Output
Get a third-party integration
Get a third-party integration
SUPABASE_ALPHA_GET_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.Input Parameters
Output
List third-party auth integrations for project
List third-party auth integrations for project
Update an API key for the project
Update an API key for the project
Append Resumable Upload
Append Resumable Upload
Append Resumable Upload Signed
Append Resumable Upload Signed
SUPABASE_APPEND_RESUMABLE_UPLOAD_SIGNEDAppend data to a signed resumable upload. Implements one TUS protocol step; callers retain Location and Upload-Offset for continuation.Input Parameters
Output
Apply a database migration
Apply a database migration
SUPABASE_APPLY_A_MIGRATIONApplies a tracked SQL database migration to a Supabase project, for schema changes or other DDL/DML operations. You can provide a migration name, rollback SQL, and an idempotency key to help prevent duplicate tracking.Input Parameters
Output
Apply Project Addon
Apply Project Addon
Beta activate custom hostname for project
Beta activate custom hostname for project
Activate vanity subdomain for project
Activate vanity subdomain for project
SUPABASE_BETA_ACTIVATE_VANITY_SUBDOMAINActivates a vanity subdomain for the specified Supabase project (e.g., ‘my-brand.supabase.co’). Important notes: - Vanity subdomains require a paid plan (Pro/Team/Enterprise) - Usage of vanity subdomains and custom domains is mutually exclusive - After activation, your project’s auth services will no longer work on the original {project-ref}.supabase.co hostname - Schedule a downtime window to update client code and OAuth providers before activatingInput Parameters
Output
Check vanity subdomain availability
Check vanity subdomain availability
SUPABASE_BETA_CHECK_VANITY_SUBDOMAIN_AVAILABILITYChecks whether a vanity subdomain is available for a Supabase project without reserving or assigning it. The endpoint requires a Pro, Team, or Enterprise organization plan.Input Parameters
Output
Setup read replica for project
Setup read replica for project
SUPABASE_BETA_CREATE_READ_REPLICAProvisions a read-only replica for a Supabase project in a specified supported AWS region to enhance read performance and reduce latency. This beta feature requires a Pro, Team, or Enterprise organization plan.Input Parameters
Output
Enable project database webhooks
Enable project database webhooks
Beta get project's custom hostname config
Beta get project's custom hostname config
SUPABASE_BETA_GET_PROJECT_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.Input Parameters
Output
Retrieve network bans for project
Retrieve network bans for project
SUPABASE_BETA_GET_PROJECT_NETWORK_BANSRetrieves the list of banned IPv4 addresses for a Supabase project using its unique project reference string; this is a read-only operation.Input Parameters
Output
Get project network restrictions
Get project network restrictions
SUPABASE_BETA_GET_PROJECT_NETWORK_RESTRICTIONSRetrieves a Supabase project’s network restriction settings, including IPv4 and IPv6 CIDR allowlists, entitlement, and application status. The response may also include the previous configuration while a change is pending.Input Parameters
Output
Get project pgsodium config
Get project pgsodium config
Get project SSL enforcement configuration
Get project SSL enforcement configuration
SUPABASE_BETA_GET_PROJECT_SSL_ENFORCEMENT_CONFIGRetrieves the SSL enforcement configuration for a specified Supabase project, indicating if SSL connections are mandated for its database.Input Parameters
https://supabase.com/dashboard/project/<project-ref>).Output
Get current vanity subdomain config
Get current vanity subdomain config
SUPABASE_BETA_GET_VANITY_SUBDOMAIN_CONFIGFetches the current vanity subdomain configuration for a Supabase project, including its status and any custom domain name. The endpoint requires a Pro, Team, or Enterprise organization plan.Input Parameters
Output
Remove project network bans
Remove project network bans
Remove read replica
Remove read replica
SUPABASE_BETA_REMOVE_READ_REPLICAInitiates removal of a specified read replica database from a Supabase project. This beta operation requires a valid replica identifier and permission to manage read replicas; redirect application traffic before removal.Input Parameters
Output
Execute project database query
Execute project database query
SUPABASE_BETA_RUN_SQL_QUERYExecutes PostgreSQL queries against a Supabase project’s database for data retrieval, modification, or schema operations. Read-only mode does not prevent detected INSERT, UPDATE, or DELETE statements from making changes.Input Parameters
Output
Beta update project network restrictions
Beta update project network restrictions
SUPABASE_BETA_UPDATE_PROJECT_NETWORK_RESTRICTIONSUpdates network access restrictions (IPv4/IPv6 CIDR lists) for a Supabase project. Changes may terminate existing connections that do not match the new rules; the returned status indicates whether the configuration is stored or applied.Input Parameters
[] removes all IPv4 restrictions, null/omitted leaves current IPv4 restrictions unchanged.[] removes all IPv6 restrictions, null/omitted leaves current IPv6 restrictions unchanged.Output
Upgrade the project's PostgreSQL version
Upgrade the project's PostgreSQL version
SUPABASE_BETA_UPGRADE_PROJECT_POSTGRES_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.Input Parameters
release_channel.Output
Cancel Project Restoration
Cancel Project Restoration
Copy Storage Object
Copy Storage Object
Count action runs
Count action runs
SUPABASE_COUNT_ACTION_RUNSCounts the number of action runs for a Supabase project using a HEAD request. Use this when you need to retrieve the total count of action runs without fetching the full list of runs.Input Parameters
Output
Count Function Results
Count Function Results
SUPABASE_COUNT_FUNCTION_RESULTSCount rows from a known exposed table-valued function using HEAD, without a body. PostgREST enforces a read-only transaction; functions attempting database writes fail. Uses an elevated secret/service_role key that bypasses Row Level Security. OAuth requires secrets:read; fine-grained PATs require api_gateway_keys_read and api_gateway_keys_secret_read for project-key discovery. Not for scalar functions.Input Parameters
Output
Count Table Rows
Count Table Rows
SUPABASE_COUNT_TABLE_ROWSCount matching rows in an exposed table or view without downloading rows. Uses an elevated secret/service-role key and bypasses Row Level Security. OAuth requires secrets:read; fine-grained personal access tokens require api_gateway_keys_read and api_gateway_keys_secret_read.Input Parameters
Output
Create new project
Create new project
SUPABASE_CREATE_A_PROJECTCreates a new Supabase project, requiring a unique name (no dots) within the organization; project creation is asynchronous.Input Parameters
Output
Bulk create secrets
Bulk create secrets
SUPABASE_CREATE_BULK_SECRETSBulk creates secrets for a Supabase project. Secret names must not start with SUPABASE_; leading and trailing whitespace is stripped from names and values before submission.Input Parameters
Output
Create a database branch
Create a database branch
SUPABASE_CREATE_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.Input Parameters
Output
Create a function
Create a function
SUPABASE_CREATE_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.Input Parameters
./index.ts or ./index.js in function’s slug directory.import_map is true. Defaults to import_map.json in function’s slug directory.Output
Create CLI login role
Create CLI login role
SUPABASE_CREATE_LOGIN_ROLECreates a temporary CLI login role for database access with specified permissions; use when setting up CLI authentication for development or administrative tasks.Input Parameters
Output
Create an organization
Create an organization
Create project signing key
Create project signing key
SUPABASE_CREATE_PROJECT_SIGNING_KEYCreate a new JWT signing key for a Supabase project, with an optional initial standby or in-use status.Input Parameters
Output
Create Resumable Upload
Create Resumable Upload
SUPABASE_CREATE_RESUMABLE_UPLOADCreate a TUS resumable upload. Uses a secret/service-role project key and bypasses Row Level Security. Implements one TUS protocol step; callers retain Location and Upload-Offset for continuation.Input Parameters
Output
Create Resumable Upload Signed
Create Resumable Upload Signed
SUPABASE_CREATE_RESUMABLE_UPLOAD_SIGNEDCreate a signed TUS resumable upload. Implements one TUS protocol step; callers retain Location and Upload-Offset for continuation.Input Parameters
Output
Create Signed Download Url
Create Signed Download Url
Create Signed Download Urls
Create Signed Download Urls
Create Signed Upload URL
Create Signed Upload URL
Create SSO provider configuration
Create SSO provider configuration
SUPABASE_CREATE_SSO_PROVIDERCreates a new SAML 2.0 Single Sign-On (SSO) provider for a Supabase project, requiring either metadata_xml or metadata_url for SAML IdP configuration.Input Parameters
name, names, default, array).Output
Create Storage Bucket
Create Storage Bucket
Create a new third-party auth integration
Create a new third-party auth integration
SUPABASE_CREATE_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.g., for SSO); the API may also support custom_jwks if sent directly.Input Parameters
oidc_issuer_url is not provided.Output
Delete all branches
Delete all branches
SUPABASE_DELETE_ALL_BRANCHESDisables preview branching for a Supabase project, which deletes all remaining branches. IMPORTANT: Before calling this endpoint, you must manually delete all non-default branches. The API will reject the request with a 422 error if non-default branches exist. Use this action when you need to completely disable the preview branching feature for a project. This action is irreversible - all branches will be permanently removed and preview branching will be disabled. Requirements: - Preview branching must be enabled on the project - All non-default branches must be deleted first - Project must be on Pro plan or above to have preview branchingInput Parameters
Output
Delete Bucket Lifecycle
Delete Bucket Lifecycle
Delete custom hostname config
Delete custom hostname config
SUPABASE_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.Input Parameters
Output
Delete branch by id
Delete branch by id
Delete edge function
Delete edge function
SUPABASE_DELETE_EDGE_FUNCTIONDeletes an Edge Function from a Supabase project by its slug. Use this action when you need to permanently remove a deployed Edge Function that is no longer needed or should be replaced. This action is irreversible — the function cannot be recovered once deleted, though you can redeploy it from source if needed.Input Parameters
Output
Delete an edge function by slug
Delete an edge function by slug
SUPABASE_DELETE_FUNCTIONPermanently 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.Input Parameters
Output
Delete Invite External Jit Access
Delete Invite External Jit Access
Delete Jit Access
Delete Jit Access
Delete CLI login roles
Delete CLI login roles
SUPABASE_DELETE_LOGIN_ROLES[Beta] Deletes existing login roles used by the Supabase CLI for the specified project. Use when you need to remove CLI authentication roles that were previously created for project access.Input Parameters
Output
Delete a project
Delete a project
SUPABASE_DELETE_PROJECTPermanently and irreversibly deletes a Supabase project and all associated resources, including databases, storage, and configurations. This action is irreversible — the project cannot be recovered once deleted. Use when you need to completely remove a project from your organization.Input Parameters
Output
Delete vanity subdomain for project
Delete vanity subdomain for project
Bulk delete secrets
Bulk delete secrets
SUPABASE_DELETE_SECRETSDeletes one or more secrets from a Supabase project by their names. This action is irreversible - deleted secrets cannot be recovered. Use this action when you need to remove environment variables or configuration secrets that are no longer needed or should be replaced. Supports both single and bulk deletion operations through the same endpoint.Input Parameters
Output
Remove an SSO provider
Remove an SSO provider
Delete Storage Bucket
Delete Storage Bucket
Delete Storage Object
Delete Storage Object
Delete Storage Objects
Delete Storage Objects
Delete Table Rows
Delete Table Rows
SUPABASE_DELETE_TABLE_ROWSPermanently delete matching rows from an exposed Supabase table or view. Uses an elevated secret/service_role project key, bypassing Row Level Security. Requires filters unless allow_all_rows explicitly permits an unfiltered delete. OAuth needs secrets:read; fine-grained PATs need api_gateway_keys_read and api_gateway_keys_secret_read to reveal the project key.Input Parameters
Output
Deploy function
Deploy function
SUPABASE_DEPLOY_FUNCTIONDeploys Edge Functions to a Supabase project using multipart upload.Input Parameters
Output
Disable preview branching
Disable preview branching
SUPABASE_DISABLE_PREVIEW_BRANCHINGDisables the preview branching feature for an existing Supabase project, identified by its unique reference ID (ref). Note: Preview branching must be enabled on the project for this operation to succeed. If the project does not have preview branching enabled, a 422 error will be returned.Input Parameters
Output
Disable project readonly mode
Disable project readonly mode
Download private object
Download private object
SUPABASE_DOWNLOAD_PRIVATE_OBJECTDownloads an object from a private Supabase Storage bucket and returns its bytes as base64 with selected metadata. Choose anon or service-role authorization; anon access requires an allowing storage policy, while service-role access bypasses row-level security. An object version and download filename can optionally be specified.Input Parameters
Output
Download Public Object
Download Public Object
Download Signed Object
Download Signed Object
Download Storage Object
Download Storage Object
Empty Storage Bucket
Empty Storage Bucket
Exchange auth code for access and refresh token
Exchange auth code for access and refresh token
SUPABASE_EXCHANGE_OAUTH_TOKEN(Beta) Implements the OAuth 2.0 token endpoint to exchange an authorization code or refresh token for access/refresh tokens, based on grant_type. This is a standard OAuth 2.0 token endpoint that uses application/x-www-form-urlencoded content type as per OAuth 2.0 specification. Requires a valid registered OAuth application client_id and client_secret. For authorization_code grant type: - Requires valid authorization code obtained from the OAuth authorization flow - Optionally requires code_verifier if PKCE was used during authorization For refresh_token grant type: - Requires valid refresh_token from a previous token exchangeInput Parameters
grant_type is ‘authorization_code’ and it was part of the original request.Output
Generate TypeScript types
Generate TypeScript types
Get action run status
Get action run status
SUPABASE_GET_ACTION_RUNRetrieves the status and details of a specific action run, including its steps, timestamps, and configuration. Use this to monitor or check the progress of an action execution.Input Parameters
Output
Get action run logs
Get action run logs
SUPABASE_GET_ACTION_RUN_LOGSRetrieves the execution logs for a specific action run by its ID. Use this to debug action executions, view output messages, and investigate errors that occurred during action runs.Input Parameters
Output
Get project auth config
Get project auth config
SUPABASE_GET_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. The returned configuration may not include every field supplied by the API.Input Parameters
Output
Get Authenticated Image Headers
Get Authenticated Image Headers
SUPABASE_GET_AUTHENTICATED_IMAGE_HEADERSGet authenticated image transformation headers. Uses a secret/service-role project key and bypasses Row Level Security.Input Parameters
Output
Get Authenticated Object Headers
Get Authenticated Object Headers
SUPABASE_GET_AUTHENTICATED_OBJECT_HEADERSRetrieve authenticated object information headers. Uses a secret/service-role project key and bypasses Row Level Security.Input Parameters
Output
Get Authenticated Object Info
Get Authenticated Object Info
SUPABASE_GET_AUTHENTICATED_OBJECT_INFORetrieve authenticated object information. Uses a secret/service-role project key and bypasses Row Level Security.Input Parameters
Output
Get Authenticated Object Info Headers
Get Authenticated Object Info Headers
SUPABASE_GET_AUTHENTICATED_OBJECT_INFO_HEADERSGet authenticated object information headers. Uses a secret/service-role project key and bypasses Row Level Security.Input Parameters
Output
Get Available Regions
Get Available Regions
SUPABASE_GET_AVAILABLE_REGIONSTool to get the list of available regions for creating a new Supabase project. Use when you need to determine which regions are available for project deployment, or to get region recommendations based on geographic location and instance size requirements. Note: This is a Beta endpoint.Input Parameters
Output
Get Backup Schedule
Get Backup Schedule
Get a database branch
Get a database branch
SUPABASE_GET_BRANCHRetrieves detailed information about a specific database branch by its name and project reference. Use this to check branch status, configuration, and metadata before performing operations on the branch.Input Parameters
Output
Get Bucket Lifecycle
Get Bucket Lifecycle
Get Bucket Lifecycle Headers
Get Bucket Lifecycle Headers
Get database branch config
Get database branch config
Get Database Disk
Get Database Disk
Get Database Metadata
Get Database Metadata
SUPABASE_GET_DATABASE_METADATAGets database metadata for the given project. Returns information about databases, schemas, and tables structure. Note: This endpoint is deprecated and may be removed in future versions.Input Parameters
Output
Get Database Openapi
Get Database Openapi
Get Disk Utilization
Get Disk Utilization
Retrieve a function
Retrieve a function
SUPABASE_GET_FUNCTIONRetrieves detailed information, metadata, configuration, and status for a specific Edge Function using its project reference ID and function slug.Input Parameters
Output
Retrieve a function body
Retrieve a function body
SUPABASE_GET_FUNCTION_BODYRetrieves the body of a specified Supabase Edge Function using its project reference and function slug. This read-only operation does not execute the function or return runtime logs.Input Parameters
Output
Get API Health Status
Get API Health Status
Get Jit Access
Get Jit Access
Get JIT access config
Get JIT access config
Get legacy signing key
Get legacy signing key
SUPABASE_GET_LEGACY_SIGNING_KEYDeprecated by the provider; no sunset date or replacement is announced. Retrieve signing key information for the project’s imported JWT secret. The endpoint may return HTTP 404 when unavailable. Behavior is unchanged.Input Parameters
Output
Get a migration
Get a migration
SUPABASE_GET_MIGRATIONRetrieves a specific database migration entry from the migration history using its version identifier. Use when you need to inspect migration details, SQL statements, or rollback commands for a specific migration version.Input Parameters
Output
Get information about an organization
Get information about an organization
Get Organization Entitlements
Get Organization Entitlements
Get performance advisors
Get performance advisors
SUPABASE_GET_PERFORMANCE_ADVISORSRetrieves project performance advisors for a Supabase project. Returns a list of performance lints that identify potential issues and optimization opportunities. Note: This endpoint is deprecated.Input Parameters
Output
Get Profile
Get Profile
Get project
Get project
Get project API key
Get project API key
SUPABASE_GET_PROJECT_API_KEYRetrieves details of a specific API key for a Supabase project by its UUID. Use when you need to inspect a single key’s configuration, type, or metadata.Input Parameters
Output
Get project API keys
Get project API keys
SUPABASE_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.Input Parameters
Output
Get project config
Get project config
SUPABASE_GET_PROJECT_CONFIGRetrieve a project’s consolidated effective database, pooler, Auth, Data API, Realtime, and Storage configuration. This Supabase Management API endpoint is Alpha and currently supports Personal Access Tokens (PATs) only; Supabase OAuth access tokens are not supported.Input Parameters
Output
Get Project Disk Autoscale Config
Get Project Disk Autoscale Config
Get Project Function Combined Stats
Get Project Function Combined Stats
Get project legacy API keys status
Get project legacy API keys status
SUPABASE_GET_PROJECT_LEGACY_API_KEYSDeprecated by the provider; no sunset date or replacement is announced. Checks whether JWT-based legacy API keys (anon, service_role) are enabled. The endpoint may return HTTP 404 when unavailable. Behavior is unchanged.Input Parameters
Output
Get project logs
Get project logs
SUPABASE_GET_PROJECT_LOGSRetrieves the unified logs stream for a Supabase project, including database, API, and edge function logs, for monitoring and debugging. Custom queries use ClickHouse SQL against the logs table, filtering by source; legacy source tables and metadata joins must be migrated. Provide both UTC timestamps for a time window; Supabase documents a last-minute fallback without both and a maximum 24-hour range. Check the response’s error field even when execution reports success. Returned row fields depend on the query.Input Parameters
Output
Get project metrics
Get project metrics
Get project PgBouncer config
Get project PgBouncer config
Get project postgres config
Get project postgres config
Get project's PostgREST config
Get project's PostgREST config
Get project's read-only mode status
Get project's read-only mode status
SUPABASE_GET_PROJECT_READONLY_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.Input Parameters
https://supabase.com/dashboard/project/<project-ref>).Output
Get project signing keys
Get project signing keys
SUPABASE_GET_PROJECT_SIGNING_KEYSTool to list all signing keys for a Supabase project. Use when you need to retrieve JWT signing keys for authentication verification or rotation management.Input Parameters
Output
Get project Supavisor configuration
Get project Supavisor configuration
Get Project Upgrade Eligibility
Get Project Upgrade Eligibility
SUPABASE_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.Input Parameters
Output
Get project upgrade status
Get project upgrade status
Get Project Usage Api Count
Get Project Usage Api Count
Get Project Usage Request Count
Get Project Usage Request Count
Get Public Image Headers
Get Public Image Headers
SUPABASE_GET_PUBLIC_IMAGE_HEADERSGet public image transformation headers.Input Parameters
Output
Get Public Object Headers
Get Public Object Headers
SUPABASE_GET_PUBLIC_OBJECT_HEADERSGet public object information headers.Input Parameters
Output
Get Public Object Info
Get Public Object Info
SUPABASE_GET_PUBLIC_OBJECT_INFOGet public object information.Input Parameters
Output
Get Realtime Config
Get Realtime Config
Get TUS resumable upload base options
Get TUS resumable upload base options
Get TUS resumable upload options
Get TUS resumable upload options
SUPABASE_GET_RESUMABLE_UPLOAD_OPTIONSHandles OPTIONS request for TUS Resumable uploads to discover server capabilities. Use when preparing resumable upload requests to verify supported TUS protocol versions and extensions.Input Parameters
Output
Get Resumable Upload Status
Get Resumable Upload Status
Get Resumable Upload Status Signed
Get Resumable Upload Status Signed
SUPABASE_GET_RESUMABLE_UPLOAD_STATUS_SIGNEDGet signed resumable upload offset and metadata. Implements one TUS protocol step; callers retain Location and Upload-Offset for continuation.Input Parameters
Output
Get Security Advisors
Get Security Advisors
SUPABASE_GET_SECURITY_ADVISORSRetrieves security advisor findings and recommendations for a Supabase project. Use when you need to audit project security posture, identify SQL-based security issues, or get remediation guidance. Note: This endpoint is deprecated and may be removed in future API versions.Input Parameters
Output
Get Signed Image Headers
Get Signed Image Headers
Get Signed Object Headers
Get Signed Object Headers
Get project's auth config
Get project's auth config
SUPABASE_GETS_PROJECT_S_AUTH_CONFIGRetrieves a project’s authentication configuration, including provider, MFA, email, SMS, JWT and security settings. The response can contain sensitive secrets.Input Parameters
Output
Get project's service health status
Get project's service health status
SUPABASE_GETS_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.Input Parameters
Output
Get a specific SQL snippet
Get a specific SQL snippet
Get a SSO provider by its UUID
Get a SSO provider by its UUID
Get Storage Bucket
Get Storage Bucket
Get Storage Bucket Headers
Get Storage Bucket Headers
Get Storage Bucket List Headers
Get Storage Bucket List Headers
Get Storage Config
Get Storage Config
Get Storage Health
Get Storage Health
Get Storage Health Headers
Get Storage Health Headers
Get Storage Object Headers
Get Storage Object Headers
SUPABASE_GET_STORAGE_OBJECT_HEADERSRetrieve object information headers. Uses a secret/service-role project key and bypasses Row Level Security.Input Parameters
Output
Get Storage Object Info
Get Storage Object Info
SUPABASE_GET_STORAGE_OBJECT_INFORetrieve object information. Uses a secret/service-role project key and bypasses Row Level Security.Input Parameters
Output
Get Storage Object Info Headers
Get Storage Object Info Headers
SUPABASE_GET_STORAGE_OBJECT_INFO_HEADERSGet object information headers. Uses a secret/service-role project key and bypasses Row Level Security.Input Parameters
Output
Get Table Schemas
Get Table Schemas
SUPABASE_GET_TABLE_SCHEMASRetrieve column details, types, primary and unique constraints, and optionally foreign keys for multiple database tables. Some returned metadata uses placeholders, and index information is not fetched.Input Parameters
Output
OPTIONS for resumable upload sign
OPTIONS for resumable upload sign
OPTIONS for resumable upload sign
OPTIONS for resumable upload sign
SUPABASE_HANDLE_RESUMABLE_UPLOAD_SIGN_OPTIONS_WITH_IDSend an OPTIONS request to a TUS resumable upload signing endpoint for a specified path.Input Parameters
Output
Insert Table Rows
Insert Table Rows
SUPABASE_INSERT_TABLE_ROWSInsert rows or upsert on primary/UNIQUE keys in an exposed table or view. Uses a secret or service_role project key and bypasses Row Level Security. OAuth needs secrets:read; fine-grained PATs need api_gateway_keys_read and api_gateway_keys_secret_read to reveal project keys. Upserts can overwrite data.Input Parameters
Output
Invite External Jit Access
Invite External Jit Access
Invoke Database Function
Invoke Database Function
SUPABASE_INVOKE_DATABASE_FUNCTIONInvoke a known exposed Postgres function with named JSON arguments. Supports custom exposed schemas and table-valued result selection, filters, ordering, pagination, and counts. The function runs with a service-role project key that bypasses Row Level Security and may create, update, or delete data or execute DDL.Input Parameters
Output
Invoke Edge Function
Invoke Edge Function
SUPABASE_INVOKE_EDGE_FUNCTIONTool to invoke a deployed Supabase Edge Function over HTTPS. Use for testing and debugging Edge Functions with configurable method, headers, body, and authentication.Input Parameters
Output
Invoke Read Only Function
Invoke Read Only Function
SUPABASE_INVOKE_READ_ONLY_FUNCTIONInvoke a known exposed Postgres function using GET in a read-only transaction. Not an Edge Function or arbitrary SQL executor. Database writes are rejected by PostgREST’s GET transaction mode. Uses a secret/service_role key that bypasses Row Level Security, so reads can expose all rows. External side effects of a function are not prevented by a database read-only transaction. Supports table-valued projection, filters, ordering, pagination, and counts. OAuth needs secrets:read; fine-grained PATs need api_gateway_keys_read and api_gateway_keys_secret_read to reveal project keys.Input Parameters
Output
List Action Runs
List Action Runs
List all organizations
List all organizations
List all projects
List all projects
List project database backups
List project database backups
List database branches
List database branches
SUPABASE_LIST_BRANCHESLists all database branches for a specified Supabase project, providing information about each branch’s status, configuration, and metadata. Use this action when you need to view all branches in a project, check branch statuses, or identify available branches before performing operations. Database branches are useful for isolated development and testing of schema changes.Input Parameters
Output
List all buckets
List all buckets
List all database branches
List all database branches
SUPABASE_LIST_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.Input Parameters
https://supabase.com/dashboard/project/<project_id>).Output
List all functions
List all functions
List Jit Access
List Jit Access
List migration history
List migration history
SUPABASE_LIST_MIGRATION_HISTORYRetrieves the list of applied database migration versions for a Supabase project. Use this to track which migrations have been applied to the project’s database. This is a read-only operation that requires the project reference ID.Input Parameters
Output
List members of an organization
List members of an organization
List Organization Projects
List Organization Projects
List Project Addons
List Project Addons
List Project Restore Versions
List Project Restore Versions
List project secrets
List project secrets
SUPABASE_LIST_PROJECT_SECRETSRetrieves all secrets (environment variables) for a Supabase project by its reference ID. Use this action when you need to view the secrets configured for a project, such as API keys, database URLs, or other environment variables. Note that secret values in the response may be masked for security reasons.Input Parameters
Output
List all secrets
List all secrets
List SQL snippets for the logged in user
List SQL snippets for the logged in user
SUPABASE_LIST_SQL_SNIPPETSRetrieves the first page of SQL snippets for the logged-in user, optionally filtered by Supabase project. The response may contain a pagination cursor, but this tool cannot request subsequent pages.Input Parameters
Output
List all SSO providers
List all SSO providers
List Storage Buckets
List Storage Buckets
List Storage Objects
List Storage Objects
List Storage Objects V2
List Storage Objects V2
List Database Tables
List Database Tables
SUPABASE_LIST_TABLESLists tables and optionally views in Supabase database schemas, providing an overview of database structure. Schema discovery can fall back to public, and per-schema failures are reported alongside any partial results.Input Parameters
Output
Merge a database branch
Merge a database branch
SUPABASE_MERGE_BRANCHInitiates a merge of a database branch into its target database. An optional migration version can limit how far migrations are merged; the response identifies the triggered workflow run.Input Parameters
Output
Modify Database Disk
Modify Database Disk
Move Storage Object
Move Storage Object
Patch a migration
Patch a migration
SUPABASE_PATCH_MIGRATION[Beta] Patches an existing entry in the project’s migration history, updating the name or rollback script. Use this to correct migration metadata after the migration has been created.Input Parameters
Output
Patch project network restrictions
Patch project network restrictions
Pause Project
Pause Project
Post Resumable Upload
Post Resumable Upload
SUPABASE_POST_RESUMABLE_UPLOADCreate a TUS upload through the wildcard creation route (an alias of base POST). Uses a secret/service-role project key and bypasses Row Level Security. Implements one TUS protocol step; callers retain Location and Upload-Offset for continuation.Input Parameters
Output
Post Resumable Upload Signed
Post Resumable Upload Signed
SUPABASE_POST_RESUMABLE_UPLOAD_SIGNEDCreate a signed TUS upload through the wildcard creation route (an alias of base POST). Implements one TUS protocol step; callers retain Location and Upload-Offset for continuation.Input Parameters
Output
Purge Bucket Cache
Purge Bucket Cache
Purge Object Cache
Purge Object Cache
Purge Storage Cache
Purge Storage Cache
Push a database branch
Push a database branch
Remove Project Addon
Remove Project Addon
Render Authenticated Image
Render Authenticated Image
SUPABASE_RENDER_AUTHENTICATED_IMAGERender an authenticated image with transformations. Uses a secret/service-role project key and bypasses Row Level Security.Input Parameters
Output
Render Public Image
Render Public Image
SUPABASE_RENDER_PUBLIC_IMAGERender a public image with transformations.Input Parameters
Output
Render Signed Image
Render Signed Image
Replace Bucket Lifecycle
Replace Bucket Lifecycle
Reset a database branch
Reset a database branch
Restart Project
Restart Project
Restore Branch
Restore Branch
Restore database PITR backup
Restore database PITR backup
Restore Project
Restore Project
Rollback Migrations
Rollback Migrations
Execute read-only database query
Execute read-only database query
SUPABASE_RUN_READ_ONLY_QUERYRun a read-only SQL query against a Supabase project as supabase_read_only_user. This beta endpoint requires all entity references to be schema-qualified.Input Parameters
Output
Select From Table
Select From Table
SUPABASE_SELECT_FROM_TABLESelect rows from a Supabase/PostgREST table or view, with column selection, filtering, sorting, and pagination. When a project API key is not supplied, the tool may use a service-role key, which bypasses row-level security.Input Parameters
<column>_<operator>=<value> in the query string (e.g., id_eq=123). Can be provided as a list of FilterItem objects. Each FilterItem must have: column (string), operator (one of: eq, neq, gt, gte, lt, lte, like, ilike, is, in, cs, cd, sl, sr, nxl, nxr, adj, ov, fts, plfts, phfts, wfts), and value (the comparison value).Output
Shutdown Realtime
Shutdown Realtime
Terminate Resumable Upload
Terminate Resumable Upload
Terminate Resumable Upload Signed
Terminate Resumable Upload Signed
SUPABASE_TERMINATE_RESUMABLE_UPLOAD_SIGNEDTerminate a signed resumable upload. Implements one TUS protocol step; callers retain Location and Upload-Offset for continuation.Input Parameters
Output
Update Action Run Status
Update Action Run Status
Update a function
Update a function
SUPABASE_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.Input Parameters
Output
Update API key
Update API key
SUPABASE_UPDATE_API_KEYUpdates an existing Supabase project API key’s name, description, or JWT template without regenerating the key. It can request that the key value be revealed in the response.Input Parameters
Output
Update Backup Schedule
Update Backup Schedule
Update branch configuration
Update branch configuration
SUPABASE_UPDATE_BRANCHUpdates the configuration of a Supabase database branch, allowing modification of its name, associated Git branch, notification URL, persistence settings, and status. Use this action when you need to modify branch settings after creation, such as linking to a different Git branch, changing the branch name, or updating persistence behavior. Note: Database branching requires a paid Supabase plan (Pro or higher).Input Parameters
Output
Update database branch config
Update database branch config
SUPABASE_UPDATE_DATABASE_BRANCH_CONFIGUpdates a Supabase database branch’s configuration, including its name, associated Git branch, persistence, and status. The reset-on-push field is deprecated and ignored by Supabase.Input Parameters
Output
Update database password
Update database password
Bulk update functions
Bulk update functions
SUPABASE_UPDATE_FUNCTIONSBulk updates Edge Functions in a Supabase project with configurations such as status and version. The operation can create new functions or replace existing ones; version increments must be supplied manually.Input Parameters
Output
Update Jit Access
Update Jit Access
Update JIT access config
Update JIT access config
SUPABASE_UPDATE_JIT_ACCESS_CONFIG[Beta] Update a Supabase project’s just-in-time (JIT) access configuration. Use to enable or disable JIT access features for privileged operations on the project.Input Parameters
Output
Update pgsodium root key
Update pgsodium root key
Update a project
Update a project
SUPABASE_UPDATE_PROJECTUpdates a Supabase project’s configuration (currently supports updating the project name). Use when you need to rename an existing project.Input Parameters
Output
Update project's auth config
Update project's auth config
SUPABASE_UPDATE_PROJECT_AUTH_CONFIGUpdate Supabase project Auth configuration via the Management API. Use to fix misconfigured Auth redirects, SMTP settings, or other auth parameters. Only provided fields are updated; others remain unchanged. Before updating, confirm the Auth service status is ACTIVE_HEALTHY by checking project health.Input Parameters
Output
Update project's custom hostname configuration
Update project's custom hostname configuration
SUPABASE_UPDATE_PROJECT_CUSTOM_HOSTNAMEUpdates the custom hostname for a Supabase project, requiring subsequent DNS changes for SSL certificate issuance and domain ownership. API errors may be returned in an error message field.Input Parameters
Output
Update project legacy API keys
Update project legacy API keys
SUPABASE_UPDATE_PROJECT_LEGACY_API_KEYSDeprecated by the provider; no sunset date or replacement is announced. Disable or re-enable JWT-based legacy API keys (anon, service_role). The endpoint may return HTTP 404 when unavailable. Behavior is unchanged.Input Parameters
Output
Update project's postgres config
Update project's postgres config
SUPABASE_UPDATE_PROJECT_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.Input Parameters
Output
Update project's PostgREST config
Update project's PostgREST config
SUPABASE_UPDATE_PROJECT_POSTGREST_CONFIGUpdates PostgREST configuration settings (e.g., max_rows, db_pool, db_schema, db_extra_search_path) for a Supabase project to fine-tune API performance, data exposure, and database resource usage.Input Parameters
null or not provided, the pool size may be automatically configured based on compute size.db_schema. An empty string can be used to clear existing paths.Output
Update database pooler config
Update database pooler config
SUPABASE_UPDATE_PROJECT_SUPAVISOR_CONFIGUpdates Supavisor (database pooler) configuration, including default pool size and pool mode, for an existing Supabase project identified by its reference.Input Parameters
Output
Update Realtime Config
Update Realtime Config
Update SSL enforcement config
Update SSL enforcement config
Update an SSO provider by its UUID
Update an SSO provider by its UUID
SUPABASE_UPDATE_SSO_PROVIDERUpdates an existing SSO provider’s SAML metadata, associated email domains, or attribute mappings for a Supabase project, identified by ref and provider_id.Input Parameters
Output
Update Storage Bucket
Update Storage Bucket
Update Storage Config
Update Storage Config
Update Storage Object
Update Storage Object
Update Table Rows
Update Table Rows
SUPABASE_UPDATE_TABLE_ROWSUpdate matching rows in an exposed Supabase table or updatable view. Uses a secret or service_role project key, bypassing Row Level Security. PostgREST warns that unfiltered PATCH updates every row: filters are required unless allow_all_rows=true. Filters can still match every row; check them carefully. OAuth needs secrets:read; fine-grained PATs need api_gateway_keys_read and api_gateway_keys_secret_read to reveal the project key.Input Parameters
Output
Upload Signed Object
Upload Signed Object
Upload Storage Object
Upload Storage Object
Upsert migration
Upsert migration
SUPABASE_UPSERT_MIGRATIONTool to upsert a database migration without applying it. Use when you need to track migration changes for a project. [Beta] This endpoint stores migration metadata without executing the SQL.