Supabase

supabase

Supabase is an open-source backend-as-a-service providing a Postgres database, authentication, storage, and real-time subscription APIs for building modern applications

Developer Tools Databases Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (79)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create project api keySUPABASE_ALPHA_CREATES_A_NEW_API_KEY_FOR_THE_PROJECTAcción

Creates a 'publishable' or 'secret' api key for an existing supabase project, optionally with a description; 'secret' keys can have customized jwt templates.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
typestringObligatorioenum
Specifies the type of API key: 'publishable' for client-side use or 'secret' for server-side operations.
publishablesecret
descriptionstring
Optional human-readable description for the API key.

Parámetros de salida

dataobjectObligatorio
Details of the newly created API key.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an API key from the projectSUPABASE_ALPHA_DELETES_AN_API_KEY_FOR_THE_PROJECTAcción

Permanently deletes a specific api key (identified by `id`) from a supabase project (identified by `ref`), revoking its access.

Parámetros de entrada

idstringObligatorio
The unique identifier of the API key that needs to be deleted from the project.
refstringObligatorio
The unique reference ID of the Supabase project from which the API key is to be deleted.

Parámetros de salida

dataobjectObligatorio
Contains the details of the API key that was successfully deleted.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a third-party integrationSUPABASE_ALPHA_GET_A_THIRD_PARTY_INTEGRATIONAcción

Retrieves the detailed configuration for a specific third-party authentication (tpa) provider, identified by `tpa id`, within an existing supabase project specified by `ref`.

Parámetros de entrada

refstringObligatorio
The unique identifier (reference) of the Supabase project.
tpa_idstringObligatorio
The unique identifier of the specific third-party authentication provider configuration to retrieve.

Parámetros de salida

dataobjectObligatorio
Contains the detailed configuration of the specified third-party authentication provider.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List third-party auth integrations for projectSUPABASE_ALPHA_LISTS_ALL_THIRD_PARTY_AUTH_INTEGRATIONSAcción

Lists 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.

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project.

Parámetros de salida

dataobject[]Obligatorio
A list of third-party authentication integration configurations for the project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete third party auth configSUPABASE_ALPHA_REMOVES_A_THIRD_PARTY_AUTH_INTEGRATIONAcción

Removes 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.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
tpa_idstringObligatorio
The unique identifier (ID) of the third-party authentication provider configuration to be removed.

Parámetros de salida

dataobjectObligatorio
Details of the third-party authentication provider configuration that was removed.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an API key for the projectSUPABASE_ALPHA_UPDATES_AN_API_KEY_FOR_THE_PROJECTAcción

Updates an existing supabase project api key's `description` and/or `secret jwt template` (which defines its `role`); does not regenerate the key string.

Parámetros de entrada

idstringObligatorio
The unique identifier of the API key that needs to be updated.
refstringObligatorio
The unique reference ID of the Supabase project to which the API key belongs.
descriptionstring
Optional new description for the API key.

Parámetros de salida

dataobjectObligatorio
An object containing the full details of the API key after the update has been applied.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Beta activate custom hostname for projectSUPABASE_BETA_ACTIVATES_A_CUSTOM_HOSTNAME_FOR_A_PROJECTAcción

Activates a previously configured custom hostname for a supabase project, assuming dns settings are verified externally.

Parámetros de entrada

refstringObligatorio
The unique identifier (project ID) of the Supabase project.

Parámetros de salida

dataobjectObligatorio
Detailed response data for the custom hostname activation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Activate vanity subdomain for projectSUPABASE_BETA_ACTIVATES_A_VANITY_SUBDOMAIN_FOR_A_PROJECTAcción

Activates a vanity subdomain for the specified supabase project, requiring subsequent dns configuration for the subdomain to become operational.

Parámetros de entrada

refstringObligatorio
Unique reference ID of the Supabase project.
vanity_subdomainstringObligatorio
Vanity subdomain to activate; you must be able to configure its DNS records.

Parámetros de salida

dataobjectObligatorio
Details of the activated vanity subdomain.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Authorize user through OAuthSUPABASE_BETA_AUTHORIZE_USER_THROUGH_OAUTHAcción

Generates a supabase oauth 2.0 authorization url for user redirection, requiring a pre-registered `client id` and a `redirect uri` that matches one of its pre-registered uris.

Parámetros de entrada

scopestring
Space-separated list of OAuth scopes for requested permissions on user resources (e.g., 'email profile', 'storage.objects.read').
statestring
Opaque value to maintain state between request and callback; returned unmodified to aid CSRF prevention.
client_idstringObligatorio
Unique identifier for the OAuth client application, registered with Supabase.
redirect_uristringObligatorio
URI where Supabase redirects the user after authorization; must exactly match a registered URI for the client application.
response_modestring
Specifies how authorization response parameters are returned (e.g., 'query', 'fragment', 'form_post'). Default is determined by `response_type` if not specified.
response_typestringObligatorioenum
Specifies the authorization flow type: 'code' for Authorization Code Grant; 'token' for Implicit Grant (access token); 'id_token token' for OIDC hybrid flows (ID and access tokens).
codeid_token tokentoken
code_challengestring
PKCE code challenge to secure authorization code grants, typically a BASE64URL-encoded SHA256 hash of `code_verifier`.
code_challenge_methodstringenum
Method to derive `code_challenge` for PKCE: 'S256'/'sha256' for SHA256 hashing; 'plain' sends verifier as is (not for production if hashing possible). Required if `code_challenge` is provided.
S256plainsha256

Parámetros de salida

dataobjectObligatorio
Dictionary with parameters from Supabase OAuth endpoint, may include a redirect URL or other flow/response_mode dependent parameters.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check vanity subdomain availabilitySUPABASE_BETA_CHECKS_VANITY_SUBDOMAIN_AVAILABILITYAcción

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

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
vanity_subdomainstringObligatorio
The desired vanity subdomain to check for availability (e.g., 'my-app'). Must be 1-63 alphanumeric characters or hyphens; cannot start or end with a hyphen.

Parámetros de salida

dataobjectObligatorio
Indicates if the vanity subdomain is available (`available: true`) or not (`available: false`).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Enable project database webhooksSUPABASE_BETA_ENABLES_DATABASE_WEBHOOKS_ON_THE_PROJECTAcción

Enables database webhooks for the supabase project `ref`, triggering real-time notifications for insert, update, or delete events.

Parámetros de entrada

refstringObligatorio
The unique identifier for the Supabase project.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project SSL enforcement configurationSUPABASE_BETA_GET_PROJECT_S_SSL_ENFORCEMENT_CONFIGURATIONAcción

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

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project. This can typically be found in your project's dashboard URL (e.g., `https://supabase.com/dashboard/project/<project-ref>`).

Parámetros de salida

dataobjectObligatorio
Contains the SSL enforcement configuration details for the project, including whether SSL is enforced for the database and if the last configuration attempt was successful.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get current vanity subdomain configSUPABASE_BETA_GETS_CURRENT_VANITY_SUBDOMAIN_CONFIGAcción

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

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project for which to fetch the vanity subdomain configuration.

Parámetros de salida

dataobjectObligatorio
Details of the project's current vanity subdomain configuration. This includes the status of the vanity subdomain (e.g., 'active', 'not-used', 'custom-domain-used') and the custom domain name, if one is configured.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Beta get project's custom hostname configSUPABASE_BETA_GETS_PROJECT_S_CUSTOM_HOSTNAME_CONFIGAcción

Retrieves 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.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project. This ID can typically be found in your project's dashboard URL.

Parámetros de salida

dataobjectObligatorio
The detailed custom hostname configuration for the specified Supabase project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve network bans for projectSUPABASE_BETA_GETS_PROJECT_S_NETWORK_BANSAcción

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

Parámetros de entrada

refstringObligatorio
The unique string identifier for the Supabase project.

Parámetros de salida

dataobjectObligatorio
Contains the list of banned IPv4 addresses for the specified project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project network restrictionsSUPABASE_BETA_GETS_PROJECT_S_NETWORK_RESTRICTIONSAcción

Retrieves the current network restriction settings (e.g., ip whitelists) for a supabase project using its reference id; this is a read-only operation for auditing or verifying network security.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project for which to retrieve network restrictions.

Parámetros de salida

dataobjectObligatorio
Contains the detailed network restriction configuration for the project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project pgsodium configSUPABASE_BETA_GETS_PROJECT_S_PGSODIUM_CONFIGAcción

Retrieves the pgsodium configuration, including the root encryption key, for an existing supabase project identified by its `ref`.

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project.

Parámetros de salida

dataobjectObligatorio
Contains the PGSodium configuration for the project, including the root key.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Beta remove a read replicaSUPABASE_BETA_REMOVE_A_READ_REPLICAAcción

Irreversibly initiates the removal of a specified read replica from an existing supabase project, confirming only the start of the process, not its completion.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project from which the read replica will be removed.
database_identifierstringObligatorio
The unique identifier of the read replica database to be removed.

Parámetros de salida

dataobjectObligatorio
A dictionary typically containing a confirmation message that the read replica removal process has been initiated.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove project network bansSUPABASE_BETA_REMOVE_NETWORK_BANSAcción

Removes specified ipv4 addresses from a supabase project's network ban list, granting immediate access; ips not currently banned are ignored.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
ipv4_addressesstring[]Obligatorio
A list of IPv4 addresses to be removed from the project's network ban list.

Parámetros de salida

dataobjectObligatorio
A dictionary containing data related to the outcome of the unban operation, typically a success message or status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Execute project database querySUPABASE_BETA_RUN_SQL_QUERYAcción

Executes a given sql query against the project's database; use for advanced data operations or when standard api endpoints are insufficient, ensuring queries are valid postgresql and sanitized. use the get table schemas or generate type script types tool to retrieve the table schema, then base your query on it.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
querystringObligatorio
The SQL query to be executed against the project's database.

Parámetros de salida

dataobjectObligatorio
Query results, whose structure varies: typically an array of objects for `SELECT`, or status/counts for `INSERT`/`UPDATE`/`DELETE`.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Setup read replica for projectSUPABASE_BETA_SET_UP_A_READ_REPLICAAcción

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

Parámetros de entrada

refstringObligatorio
Unique reference ID of the Supabase project.
read_replica_regionstringObligatorioenum
AWS region for the read replica; selecting one closer to users improves performance and reduces latency.
ap-east-1ap-northeast-1ap-northeast-2ap-south-1ap-southeast-1ap-southeast-2ca-central-1eu-central-1eu-central-2eu-north-1eu-west-1eu-west-2+6

Parámetros de salida

dataobjectObligatorio
Information about the read replica setup, including status updates or details of the replica.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Beta update project network restrictionsSUPABASE_BETA_UPDATES_PROJECT_S_NETWORK_RESTRICTIONSAcción

Updates and applies network access restrictions (ipv4/ipv6 cidr lists) for a supabase project, which may terminate existing connections not matching the new rules.

Parámetros de entrada

refstringObligatorio
Unique reference ID of the Supabase project.
dbAllowedCidrsstring[]
List of IPv4 addresses or CIDR notations for database access; `[]` removes all IPv4 restrictions, `null`/omitted leaves current IPv4 restrictions unchanged.
dbAllowedCidrsV6string[]
List of IPv6 addresses or CIDR notations for database access; `[]` removes all IPv6 restrictions, `null`/omitted leaves current IPv6 restrictions unchanged.

Parámetros de salida

dataobjectObligatorio
Applied network restrictions details: entitlement, current/previous configurations, and status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upgrade the project's PostgreSQL versionSUPABASE_BETA_UPGRADES_THE_PROJECT_S_POSTGRES_VERSIONAcción

Initiates 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.

Parámetros de entrada

refstringObligatorio
The project's unique reference ID.
target_versionstringObligatorio
Target PostgreSQL version (e.g., '15.1.0.123'); must be available in the specified `release_channel`.
release_channelstringObligatorioenum
Release channel for selecting the PostgreSQL version.
alphabetagainternalwithdrawn

Parámetros de salida

dataobjectObligatorio
Contains data for the initiated PostgreSQL upgrade, including the `tracking_id`.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update pgsodium root keySUPABASE_CONFIG_PGSODIUM_UPDATE_WITH_ROOT_KEY_WARNINGAcción

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 to prevent irreversible data loss.

Parámetros de entrada

refstringObligatorio
The unique identifier (ref ID) of the Supabase project.
root_keystringObligatorio
The new root encryption key for pgsodium. Must be a cryptographically strong key.

Parámetros de salida

dataobjectObligatorio
Confirmation of the updated pgsodium configuration, including the newly set root key.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a database branchSUPABASE_CREATE_A_DATABASE_BRANCHAcción

Creates 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.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the parent Supabase project.
regionstring
Geographical region for the new database branch.
git_branchstring
Git branch name to associate with this database branch, linking database states to code branches.
persistentboolean
Specifies if the branch is persistent (true) or ephemeral (false); ephemeral branches might be auto-deleted.
branch_namestringObligatorio
A unique name for the new database branch.
postgres_enginestringenum
Desired PostgreSQL engine version for the new branch.
15
release_channelstringenum
Release channel for Supabase features on this branch, determining feature stability.
alphabetagainternalwithdrawn
desired_instance_sizestringenum
Compute instance size for the new database branch.
12xlarge16xlarge2xlarge4xlarge8xlargelargemediummicrosmallxlarge

Parámetros de salida

dataobjectObligatorio
Contains the details of the newly created database branch, including its ID, name, status, and configuration.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a functionSUPABASE_CREATE_A_FUNCTIONAcción

Creates a new serverless edge function for a supabase project (identified by `ref`), requiring valid javascript/typescript in `body` and a project-unique `slug 1` identifier.

Parámetros de entrada

refstringObligatorio
Project's unique identifier (path parameter).
bodystringObligatorio
JavaScript or TypeScript source code for the Edge Function (populates JSON body `body` field).
namestringObligatorio
Human-readable name for the function (populates JSON body `name` field).
slugstringObligatorio
URL-friendly identifier for the function's route prefix (populates JSON body `slug` field).
import_mapboolean
If true, enable import map for ES module resolution (query parameter).
verify_jwtboolean
If true, verify JWT in Authorization header (populates JSON body `verify_jwt` field).
entrypoint_pathstring
Path to main function code, relative to project's functions directory (query parameter). Defaults to `./index.ts` or `./index.js` in function's slug directory.
import_map_pathstring
Path to import map JSON, relative to project's functions directory; used if `import_map` is true (query parameter). Defaults to `import_map.json` in function's slug directory.

Parámetros de salida

dataobjectObligatorio
Details of the newly created Edge Function.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an organizationSUPABASE_CREATE_AN_ORGANIZATIONAcción

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

Parámetros de entrada

namestringObligatorio
The name for the new organization.

Parámetros de salida

dataobjectObligatorio
The newly created organization's details, including its unique 'id' and assigned 'name'.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create new projectSUPABASE_CREATE_A_PROJECTAcción

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

Parámetros de entrada

namestringObligatorio
Name for the new project; must be unique within the organization and not contain dots.
planstringenum
Subscription plan (set at organization level, ignored in this request).
freepro
regionstringObligatorioenum
Geographical region for the project's server and database.
ap-east-1ap-northeast-1ap-northeast-2ap-south-1ap-southeast-1ap-southeast-2ca-central-1eu-central-1eu-central-2eu-north-1eu-west-1eu-west-2+6
db_passstringObligatorio
Password for the new database.
kps_enabledboolean
Deprecated and ignored.
template_urlstring
Optional URL to a Supabase project template (e.g., from Git) to initialize the project.
organization_idstringObligatorio
Unique identifier (slug) of the organization.
postgres_enginestringenum
PostgreSQL engine version (defaults to latest stable).
15
release_channelstringenum
Release channel for Supabase features (defaults to 'ga').
alphabetagainternalwithdrawn
desired_instance_sizestringenum
Desired compute instance size for the project (affects performance/cost; defaults if unspecified).
12xlarge16xlarge2xlarge4xlarge8xlargelargemediummicrosmallxlarge

Parámetros de salida

dataobjectObligatorio
Details of the newly created Supabase project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create SSO provider configurationSUPABASE_CREATES_A_NEW_SSO_PROVIDERAcción

Creates 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.

Parámetros de entrada

refstringObligatorio
Unique reference ID of the Supabase project.
typestringObligatorioenum
Type of the SSO provider; 'saml' (SAML 2.0) is the only supported value.
saml
domainsstring[]
Email domains to associate with this SSO provider; users from these domains will be directed here for authentication.
metadata_urlstring
URL to fetch SAML 2.0 metadata XML. Provide this or `metadata_xml`.
metadata_xmlstring
SAML 2.0 metadata XML document as a string. Provide this or `metadata_url`.
attribute__mapping__keysobject
Maps SAML assertion attributes to custom Supabase JWT claims. Keys are JWT claim names; values specify SAML attribute extraction rules (e.g., `name`, `names`, `default`, `array`).

Parámetros de salida

dataobjectObligatorio
Successfully created SSO provider's configuration details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a new third-party auth integrationSUPABASE_CREATES_A_NEW_THIRD_PARTY_AUTH_INTEGRATIONAcción

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 api may also support `custom jwks` if sent directly.

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project.
jwks_urlstring
URL of the JSON Web Key Set (JWKS) for public key verification. Required if `oidc_issuer_url` is not provided.
oidc_issuer_urlstring
URL of the OpenID Connect (OIDC) issuer. Required if `jwks_url` is not provided.

Parámetros de salida

dataobjectObligatorio
Details of the newly configured third-party authentication integration.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reverify custom hostnameSUPABASE_CUSTOM_HOSTNAME_DNS_VERIFICATIONAcción

Re-verifies dns and ssl configurations for an existing custom hostname associated with a supabase project.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project for which the custom hostname is being re-verified.

Parámetros de salida

dataobjectObligatorio
Contains the comprehensive status and detailed verification data for the custom hostname following the re-verification attempt.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete branch by idSUPABASE_DELETE_A_DATABASE_BRANCHAcción

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

Parámetros de entrada

branch_idstringObligatorio
The unique identifier of the database branch to be deleted.

Parámetros de salida

dataobjectObligatorio
Contains the response data, typically a message confirming the branch deletion.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an edge function by slugSUPABASE_DELETE_A_FUNCTIONAcción

Permanently 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.

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project from which the function will be deleted.
function_slugstringObligatorio
The unique identifier (slug) of the Edge Function to be deleted. This is typically the name given to the function upon creation.

Parámetros de salida

dataobjectObligatorio
A dictionary that is typically empty or contains a success message upon successful deletion of the function.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete custom hostname configSUPABASE_DELETE_CUSTOM_HOSTNAME_CONFIGAcción

Deletes 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.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project for which the custom hostname configuration will be deleted.

Parámetros de salida

dataobjectObligatorio
Response data from the API after attempting to delete the custom hostname. While a dictionary is expected, it might be empty or contain a simple status message (e.g., {'status': 'success'}) upon successful deletion.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete vanity subdomain for projectSUPABASE_DELETE_PROJECT_VANITY_SUBDOMAINAcción

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

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the result of the vanity subdomain deletion, typically including a confirmation or status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete project by refSUPABASE_DELETES_THE_GIVEN_PROJECTAcción

Permanently and irreversibly deletes a supabase project, identified by its unique `ref` id, resulting in complete data loss.

Parámetros de entrada

refstringObligatorio
Unique reference ID of the Supabase project to delete, typically a short alphanumeric string assigned upon creation.

Parámetros de salida

dataobjectObligatorio
Details of the project that was successfully deleted.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Deploy functionSUPABASE_DEPLOY_FUNCTIONAcción

Deploys edge functions to a supabase project using multipart upload.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
filestringObligatorio
Function code file content or path to deploy.
slugstring
Function slug to deploy. If not provided, deploys all functions.
bundleOnlyboolean
If true, only bundle the function without deploying.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Disable project readonly modeSUPABASE_DISABLE_PROJECT_READONLYAcción

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 automatically reverts to read-only.

Parámetros de entrada

refstringObligatorio
Unique reference ID of the Supabase project.

Parámetros de salida

dataobjectObligatorio
API response data, usually confirming the disable operation's status; structure may vary.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Disable preview branchingSUPABASE_DISABLES_PREVIEW_BRANCHINGAcción

Disables the preview branching feature for an existing supabase project, identified by its unique reference id (`ref`).

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project for which preview branching is to be disabled.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the API response data, typically confirming the disablement or providing status information regarding the preview branching feature.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Exchange auth code for access and refresh tokenSUPABASE_EXCHANGE_O_AUTH_TOKENAcción

(beta) implements the oauth 2.0 token endpoint to exchange an authorization code or refresh token for access/refresh tokens, based on `grant type`.

Parámetros de entrada

codestring
Authorization code from the server; required if `grant_type` is 'authorization_code'.
client_idstringObligatorio
Application's client ID.
grant_typestringObligatorioenum
OAuth 2.0 grant type that dictates the token exchange flow.
authorization_coderefresh_token
redirect_uristring
Redirect URI from the initial authorization; required if `grant_type` is 'authorization_code' and it was part of the original request.
client_secretstringObligatorio
Application's client secret.
code_verifierstring
PKCE code verifier; required if PKCE was used with an 'authorization_code' grant type.
refresh_tokenstring
Refresh token for acquiring a new access token; required if `grant_type` is 'refresh_token'.

Parámetros de salida

dataobjectObligatorio
Token data returned upon successful exchange.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate TypeScript typesSUPABASE_GENERATE_TYPE_SCRIPT_TYPESAcción

Generates and retrieves typescript types from a supabase project's database; any schemas specified in `included schemas` must exist in the project.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project for which to generate TypeScript types.
included_schemasstring
Comma-separated database schema names to include in the generated TypeScript types.

Parámetros de salida

dataobjectObligatorio
Contains the generated TypeScript definitions.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get database branch configSUPABASE_GET_DATABASE_BRANCH_CONFIGAcción

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

Parámetros de entrada

branch_idstringObligatorio
The unique identifier of the Supabase branch.

Parámetros de salida

dataobjectObligatorio
Contains the detailed configuration and status of the database branch.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project API keysSUPABASE_GET_PROJECT_API_KEYSAcción

Retrieves all api keys for an existing supabase project, specified by its unique reference id (`ref`); this is a read-only operation.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project for which to retrieve API keys.

Parámetros de salida

dataobject[]Obligatorio
A list of API key objects, each containing details about an API key associated with the project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project PgBouncer configSUPABASE_GET_PROJECT_S_PGBOUNCER_CONFIGAcción

Retrieves the active pgbouncer configuration (postgresql connection pooler) for a supabase project, used for performance tuning, auditing, or getting the connection string.

Parámetros de entrada

refstringObligatorio
The unique ID of the Supabase project.

Parámetros de salida

dataobjectObligatorio
Contains the detailed PgBouncer configuration settings for the specified project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project Upgrade EligibilitySUPABASE_GET_PROJECT_UPGRADE_ELIGIBILITYAcción

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

Parámetros de entrada

refstringObligatorio
Unique identifier of the Supabase project.

Parámetros de salida

dataobjectObligatorio
Detailed eligibility status and related information for the project upgrade.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project upgrade statusSUPABASE_GET_PROJECT_UPGRADE_STATUSAcción

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

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.

Parámetros de salida

dataobjectObligatorio
Contains the `DatabaseUpgradeStatus` object which provides detailed information about the project's database upgrade, including its current status, progress, target version, and any errors encountered.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a specific SQL snippetSUPABASE_GETS_A_SPECIFIC_SQL_SNIPPETAcción

Retrieves a specific sql snippet by its unique identifier.

Parámetros de entrada

idstringObligatorio
The unique identifier of the SQL snippet to retrieve.

Parámetros de salida

dataobjectObligatorio
Contains the details of the retrieved SQL snippet.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a SSO provider by its UUIDSUPABASE_GETS_A_SSO_PROVIDER_BY_ITS_UUIDAcción

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 supabase project.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
provider_idstringObligatorio
The unique identifier (UUID) of the SSO provider whose configuration is to be fetched.

Parámetros de salida

dataobjectObligatorio
Contains the detailed configuration of the specified SSO provider, including its ID, SAML settings (if applicable), associated domains, and creation/update timestamps.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get information about an organizationSUPABASE_GETS_INFORMATION_ABOUT_THE_ORGANIZATIONAcción

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

Parámetros de entrada

slugstringObligatorio
The unique, URL-friendly identifier of the organization.

Parámetros de salida

dataobjectObligatorio
Contains detailed information about the organization, including its plan, opt-in tags, allowed release channels, ID, and name.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project's auth configSUPABASE_GETS_PROJECT_S_AUTH_CONFIGAcción

Retrieves the project's complete read-only authentication configuration, detailing all settings (e.g., providers, mfa, email/sms, jwt, security policies) but excluding sensitive secrets.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.

Parámetros de salida

dataobjectObligatorio
Contains the detailed authentication configuration settings for the project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project postgres configSUPABASE_GETS_PROJECT_S_POSTGRES_CONFIGAcción

Retrieves 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.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.

Parámetros de salida

dataobjectObligatorio
Contains the detailed PostgreSQL configuration settings for the specified project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project's PostgREST configSUPABASE_GETS_PROJECT_S_POSTGREST_CONFIGAcción

Retrieves the postgrest configuration for a specific supabase project.

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project.

Parámetros de salida

dataobjectObligatorio
The PostgREST configuration details for the specified project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project's service health statusSUPABASE_GETS_PROJECT_S_SERVICE_HEALTH_STATUSAcción

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

Parámetros de entrada

refstringObligatorio
The unique identifier (ref) of the Supabase project.
servicesstring[]Obligatorio
A list of specific services for which to retrieve health status. If omitted, the health of all services will be checked.
timeout_msinteger
Optional timeout in milliseconds for the health check request.

Parámetros de salida

dataobject[]Obligatorio
A list, where each item details the health status of a service within the project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project Supavisor configurationSUPABASE_GETS_PROJECT_S_SUPAVISOR_CONFIGAcción

Retrieves the supavisor (connection pooler) configuration for a specified supabase project, identified by its reference id.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.

Parámetros de salida

dataobject[]Obligatorio
A list of Supavisor (database pooler) configuration details for the project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Table SchemasSUPABASE_GET_TABLE_SCHEMASAcción

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

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project
table_namesstring[]Obligatorio
List of table names to retrieve schemas for. Tables can be from different schemas (e.g., 'public.users', 'operations.call_queue_items'). Without schema prefix, 'public' is assumed.
include_indexesboolean
Whether to include index information in the response
exclude_null_valuesboolean
Whether to exclude properties with null values from the response for cleaner output
include_relationshipsboolean
Whether to include foreign key relationships in the response

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all database branchesSUPABASE_LIST_ALL_DATABASE_BRANCHESAcción

Lists all database branches for a specified supabase project, used for isolated development and testing of schema changes; ensure the project reference id is valid.

Parámetros de entrada

refstringObligatorio
The unique identifier (reference ID) of the Supabase project. This ID can be found in your project's dashboard URL (e.g., `https://supabase.com/dashboard/project/<project_id>`).

Parámetros de salida

dataobject[]Obligatorio
A list of database branch objects, each detailing a branch for the specified project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all functionsSUPABASE_LIST_ALL_FUNCTIONSAcción

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

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project.

Parámetros de salida

dataobject[]Obligatorio
A list containing details of all Edge Functions within the specified project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all organizationsSUPABASE_LIST_ALL_ORGANIZATIONSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of organizations, where each item provides the organization's unique 'id' and 'name'.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all projectsSUPABASE_LIST_ALL_PROJECTSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of projects, where each item provides details about a specific project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all secretsSUPABASE_LIST_ALL_SECRETSAcción

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

Parámetros de entrada

refstringObligatorio
The unique reference ID (ref) of the Supabase project whose secrets are to be retrieved.

Parámetros de salida

dataobject[]Obligatorio
Contains the list of `ModelItem` objects, where each object represents a secret with its `name` and `value`. Secret values might be masked.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List members of an organizationSUPABASE_LIST_MEMBERS_OF_AN_ORGANIZATIONAcción

Retrieves all members of a supabase organization, identified by its unique slug, including their user id, username, email, role, and mfa status.

Parámetros de entrada

slugstringObligatorio
The unique identifier (slug) of the organization for which to list members.

Parámetros de salida

dataobject[]Obligatorio
A list of members belonging to the specified organization, including their user ID, username, email (if available), assigned role name, and Multi-Factor Authentication (MFA) status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project database backupsSUPABASE_LISTS_ALL_BACKUPSAcción

Lists 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.

Parámetros de entrada

refstringObligatorio
The unique identifier (reference string) of the Supabase project.

Parámetros de salida

dataobjectObligatorio
Detailed backup information: region, WAL-G/PITR status, and list of individual backups.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all bucketsSUPABASE_LISTS_ALL_BUCKETSAcción

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

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project.

Parámetros de salida

dataobject[]Obligatorio
List of storage bucket details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all SSO providersSUPABASE_LISTS_ALL_SSO_PROVIDERSAcción

Lists all configured single sign-on (sso) providers for a supabase project, requiring the project reference id (`ref`) of an existing project.

Parámetros de entrada

refstringObligatorio
The project's reference ID. Typically found in dashboard settings or the API URL.

Parámetros de salida

dataobjectObligatorio
List of SSO provider configurations for the project. Each item, detailed in the `Model` schema, includes SAML settings and associated domains.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List SQL snippets for the logged in userSUPABASE_LISTS_SQL_SNIPPETS_FOR_THE_LOGGED_IN_USERAcción

Retrieves a list of sql snippets for the logged-in user, optionally filtered by a specific supabase project if `project ref` is provided.

Parámetros de entrada

project_refstring
The unique identifier for your Supabase project. It is a 20-digit string used to reference and manage your project in API endpoints. This can be found in Supabase Studio under Settings > General > Project Settings > Reference ID.

Parámetros de salida

dataobjectObligatorio
A list of SQL snippets associated with the logged-in user and specified project, if provided.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove an SSO providerSUPABASE_REMOVES_A_SSO_PROVIDER_BY_ITS_UUIDAcción

Deletes 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.

Parámetros de entrada

refstringObligatorio
The unique identifier for your Supabase project.
provider_idstringObligatorio
The unique identifier (UUID) of the SSO provider to be removed.

Parámetros de salida

dataobjectObligatorio
Contains the details of the SSO provider that was removed.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reset a database branchSUPABASE_RESETS_A_DATABASE_BRANCHAcción

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

Parámetros de entrada

branch_idstringObligatorio
The unique identifier of the database branch to reset.

Parámetros de salida

dataobjectObligatorio
Contains the confirmation message from the branch reset operation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Restore database PITR backupSUPABASE_RESTORES_A_PITR_BACKUP_FOR_A_DATABASEAcción

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 with pitr and physical backups enabled.

Parámetros de entrada

refstringObligatorio
Unique identifier of the Supabase project.
recovery_time_target_unixintegerObligatorio
Unix timestamp (seconds) for the desired database restoration point.

Parámetros de salida

dataobjectObligatorio
Details of the restoration process.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a functionSUPABASE_RETRIEVE_A_FUNCTIONAcción

Retrieves detailed information, metadata, configuration, and status for a specific edge function using its project reference id and function slug.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
function_slugstringObligatorio
The unique identifier (slug) for the Edge Function.

Parámetros de salida

dataobjectObligatorio
Contains the detailed information of the retrieved Supabase Edge Function.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a function bodySUPABASE_RETRIEVE_A_FUNCTION_BODYAcción

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 does not execute the function or return runtime logs.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
function_slugstringObligatorio
The unique identifier (slug) of the serverless Edge Function whose body is to be retrieved. This is typically the function's name.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get project's read-only mode statusSUPABASE_RETURNS_PROJECT_S_READONLY_MODE_STATUSAcción

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.

Parámetros de entrada

refstringObligatorio
Project reference ID, found in your project's dashboard URL (e.g., `https://supabase.com/dashboard/project/<project-ref>`).

Parámetros de salida

dataobjectObligatorio
Details of the project's read-only mode status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a functionSUPABASE_UPDATE_A_FUNCTIONAcción

Updates an existing supabase edge function's properties (like name, slug, source code, jwt settings, import map) identified by project `ref` and `function slug`, supporting plain text code or eszip for the body.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
bodystring
New source code (e.g., Deno/TypeScript) or base64-encoded ESZIP content for the function, sent in the request body.
namestring
Optional new name for the function. This value is sent in the request body as 'name'.
slugstring
Optional new slug for the function. If provided as a query parameter, this changes the function's access URL.
import_mapboolean
Whether to use an import map for the function (query parameter).
verify_jwtboolean
Specifies whether JWT verification should be enabled. This value is sent in the request body as 'verify_jwt'.
function_slugstringObligatorio
The current slug (unique identifier) of the Edge Function to be updated.
entrypoint_pathstring
Path to the main Deno script for the function (query parameter).
import_map_pathstring
Path to the import map file (query parameter).

Parámetros de salida

dataobjectObligatorio
Contains the full details of the updated Edge Function.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update database branch configSUPABASE_UPDATE_DATABASE_BRANCH_CONFIGAcción

Updates the configuration of a supabase database branch, allowing modification of its name, associated git branch, reset-on-push behavior, persistence, and status.

Parámetros de entrada

statusstringenum
Desired status for the branch. Direct setting might be overridden by system processes. If not provided, status remains unchanged.
CREATING_PROJECTFUNCTIONS_DEPLOYEDFUNCTIONS_FAILEDMIGRATIONS_FAILEDMIGRATIONS_PASSEDRUNNING_MIGRATIONS
branch_idstringObligatorio
Unique identifier of the database branch to update.
git_branchstring
Name of the Git branch to associate with this database branch. If not provided, the association remains unchanged.
persistentboolean
If true, the database branch is persistent; non-persistent branches may be auto-cleaned. If not provided, this setting remains unchanged.
branch_namestring
New name for the database branch. If not provided, the name remains unchanged.
reset_on_pushboolean
If true, resets the database branch on new push to the linked Git branch. If not provided, this setting remains unchanged.

Parámetros de salida

dataobjectObligatorio
Updated configuration details of the database branch.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project's custom hostname configurationSUPABASE_UPDATE_PROJECT_CUSTOM_HOSTNAME_ACTIONAcción

Updates the custom hostname for a supabase project, requiring subsequent dns changes to a user-controlled domain for ssl certificate issuance and domain ownership.

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project.
custom_hostnamestringObligatorio
Desired custom hostname (e.g., 'api.example.com') to associate with the project's services.

Parámetros de salida

dataobjectObligatorio
The response payload containing the status and details of the custom hostname configuration update.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an SSO provider by its UUIDSUPABASE_UPDATES_A_SSO_PROVIDER_BY_ITS_UUIDAcción

Updates an existing sso provider's saml metadata, associated email domains, or attribute mappings for a supabase project, identified by `ref` and `provider id`.

Parámetros de entrada

refstringObligatorio
Unique reference ID of the Supabase project.
domainsstring[]
Email domains to associate with this SSO provider for user authentication.
provider_idstringObligatorio
UUID of the SSO provider to update.
metadata_urlstring
URL pointing to the SAML metadata XML. Use either this or `metadata_xml`.
metadata_xmlstring
SAML metadata XML content from the identity provider. Use either this or `metadata_url`.
attribute__mapping__keysobject
Defines mapping of SAML assertion attributes to Supabase user attributes (e.g., 'email', 'full_name'). Values specify IdP attribute mapping using 'name', 'names' (for concatenation), or 'default'.

Parámetros de salida

dataobjectObligatorio
Full configuration of the SSO provider after the update.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project's postgres configSUPABASE_UPDATES_PROJECT_S_POSTGRES_CONFIGAcción

Updates 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.

Parámetros de entrada

refstringObligatorio
The unique reference ID of the Supabase project.
work_memstring
Memory for internal sorts and hash tables before writing to temp disk files (e.g., '4MB', '64MB').
max_wal_sizestring
WAL size that triggers a checkpoint (e.g., '1GB', '2048MB').
wal_keep_sizestring
Minimum size of past WAL log segments in pg_wal for standby servers (e.g., '128MB', '512MB'); replaces older wal_keep_segments.
shared_buffersstring
Memory for shared memory buffers (e.g., '128MB', '1GB').
max_connectionsinteger
Maximum concurrent database connections. Typically between 1 and 262143.
statement_timeoutstring
Maximum allowed duration for any SQL statement (e.g., '10000ms', '30s'); '0' typically disables timeout.
effective_cache_sizestring
Estimated disk cache size for a single query (e.g., '4GB', '512MB').
maintenance_work_memstring
Maximum memory for maintenance operations like VACUUM, CREATE INDEX (e.g., '64MB', '1GB').
max_parallel_workersinteger
Maximum workers the system can support for parallel queries. Typically between 0 and 1024.
max_worker_processesinteger
Maximum background processes the system can support. Typically between 0 and 262143.
max_slot_wal_keep_sizestring
Maximum WAL file size replication slots can retain in pg_wal (e.g., '1GB', '512MB'). '0' might mean unlimited; check PostgreSQL docs.
session_replication_rolestringenum
Controls firing of replication-related triggers and rules for the current session.
localoriginreplica
max_locks_per_transactioninteger
Controls the average number of object locks allocated per transaction. Typically between 10 and 2147483640.
max_standby_archive_delaystring
Maximum delay before canceling queries on a hot standby server processing archived WAL data (e.g., '30s', '0ms' to disable).
max_standby_streaming_delaystring
Maximum delay before canceling queries on a hot standby server processing streamed WAL data (e.g., '30s', '0ms' to disable).
max_parallel_workers_per_gatherinteger
Maximum workers for a single Gather or Gather Merge node in a parallel query. Typically between 0 and 1024.
max_parallel_maintenance_workersinteger
Maximum parallel processes for a single maintenance utility command. Typically between 0 and 1024.

Parámetros de salida

dataobjectObligatorio
The updated PostgreSQL configuration reflecting the applied changes.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project's PostgREST configSUPABASE_UPDATES_PROJECT_S_POSTGREST_CONFIGAcción

Updates 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.

Parámetros de entrada

refstringObligatorio
The unique identifier (reference) of the Supabase project.
db_poolinteger
The maximum number of connections in the PostgreSQL connection pool for PostgREST. If `null` or not provided, the pool size may be automatically configured based on compute size.
max_rowsinteger
The maximum number of rows PostgREST can return in a single response; this setting helps control payload size and query performance.
db_schemastring
A comma-separated string of PostgreSQL schemas to be exposed through the PostgREST API (e.g., 'public,api').
db_extra_search_pathstring
A comma-separated string of additional PostgreSQL schemas to search for objects if not found in the primary schema(s) defined by `db_schema`. An empty string can be used to clear existing paths.

Parámetros de salida

dataobjectObligatorio
Contains the updated PostgREST configuration settings for the project.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update database pooler configSUPABASE_UPDATES_PROJECT_S_SUPAVISOR_CONFIGAcción

Updates the supavisor (database pooler) configuration, such as `default pool size`, for an existing supabase project identified by `ref`; the `pool mode` parameter in the request is deprecated and ignored.

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project.
pool_modestringenum
This field is deprecated and is ignored in this request. It previously controlled the pooling mode (session or transaction).
sessiontransaction
default_pool_sizeinteger
Default number of connections per user for the connection pool; helps manage concurrent database connections and performance. Optimal value depends on project's compute add-on size and workload.

Parámetros de salida

dataobjectObligatorio
Contains the updated Supavisor configuration, including `default_pool_size` and current `pool_mode`.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update SSL enforcement configSUPABASE_UPDATE_SSL_ENFORCEMENT_CONFIGAcción

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

Parámetros de entrada

refstringObligatorio
The unique identifier of the Supabase project.
requestedConfig__databaseboolean
Desired SSL enforcement state for the project's database (`true` to enable, `false` to disable).

Parámetros de salida

dataobjectObligatorio
Contains the outcome of the SSL enforcement update request, including the new configuration status and whether the update was successful.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not