Team
Shared credential for production and unattended runs.
Connect Supabase with Hookshot™ and your stack
Supabase is an open-source backend-as-a-service providing a Postgres database, authentication, storage, and real-time subscription APIs for building modern applications
Tools and triggers
What Agents can do in Supabase
Available tools and events after Supabase is connected.
-
Activate Vanity Subdomain for Project
Activates 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…
-
Apply a Database Migration
Tool to apply database migrations to a Supabase project. Use when you need to execute SQL schema changes, create tables, alter columns, or run other DDL/DML operations as part of a tracked migration. This is a Beta…
-
Authorize User Through OAuth
Generates a Supabase OAuth 2.0 authorization URL for user redirection. IMPORTANT: This action requires a pre-registered OAuth client_id and a redirect_uri that matches one of the pre-registered URIs for that OAuth…
-
Beta Activate Custom Hostname for Project
Activates a previously configured custom hostname for a Supabase project, assuming DNS settings are verified externally.
-
Beta Get Project's Custom Hostname Config
Retrieves a Supabase project's custom hostname configuration, including its status, SSL certificate, and ownership verification, noting that availability may depend on the project's plan.
-
Beta Update Project Network Restrictions
Updates and applies network access restrictions (IPv4/IPv6 CIDR lists) for a Supabase project, which may terminate existing connections not matching the new rules.
-
Bulk Create Secrets
Tool to bulk create secrets for a Supabase project. Use when you need to create multiple project secrets at once. Each secret name must not start with SUPABASE_.
-
Bulk Delete Secrets
Deletes 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…
-
Bulk Update Functions
Tool to bulk update Edge Functions in a Supabase project. Use when you need to update multiple functions at once with new configurations such as status, version, or other properties.
-
Check Vanity Subdomain Availability
Checks if a specific vanity subdomain is available for a Supabase project; this action does not reserve or assign the subdomain.
-
Count Action Runs
Counts 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.
-
Create a Database Branch
Creates a new, isolated database branch from an existing Supabase project (identified by `ref`), useful for setting up separate environments like development or testing, which can optionally be linked to a Git branch.
-
Create a Function
Creates a new serverless Edge Function for a Supabase project (identified by `ref`), requiring valid JavaScript/TypeScript in `body` and a project-unique `slug` identifier.
-
Create a New Third-Party Auth Integration
Call this to add a new third-party authentication method (OIDC or JWKS) to a Supabase project for integrating external identity providers (e.g., for SSO); the API may also support `custom_jwks` if sent directly.
-
Create an Organization
Creates a new Supabase organization, which serves as a top-level container for projects, billing, and team access.
-
Create CLI Login Role
Creates a temporary CLI login role for database access with specified permissions; use when setting up CLI authentication for development or administrative tasks.
-
Create New Project
Creates a new Supabase project, requiring a unique name (no dots) within the organization; project creation is asynchronous.
-
Create Project Api Key
Creates a 'publishable' or 'secret' API key for an existing Supabase project, optionally with a description; 'secret' keys can have customized JWT templates.
-
Create Project Signing Key
Create a new signing key for JWT authentication in a Supabase project. The key is created in standby status by default and must be activated separately.
-
Create SSO Provider Configuration
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.
-
Delete a Project
Permanently 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…
-
Delete All Branches
Disables 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…
-
Delete an API Key From the Project
Permanently deletes a specific API key (identified by `id`) from a Supabase project (identified by `ref`), revoking its access.
-
Delete an Edge Function by Slug
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.
-
Delete Branch by Id
Permanently and irreversibly deletes a specific, non-default database branch by its `branch_id`, without affecting other branches.
-
Delete CLI 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.
-
Delete Custom Hostname Config
Deletes an active custom hostname configuration for the project identified by `ref`, reverting to the default Supabase-provided hostname; this action immediately makes the project inaccessible via the custom domain and…
-
Delete Edge Function
Deletes 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 —…
-
Delete Third Party Auth Config
Removes a third-party authentication provider (e.g., Google, GitHub) from a Supabase project's configuration; this immediately prevents users from logging in via that method.
-
Delete Vanity Subdomain for Project
Permanently and irreversibly deletes an active vanity subdomain configuration for the specified Supabase project, reverting it to its default Supabase URL.
-
Deploy Function
Deploys Edge Functions to a Supabase project using multipart upload.
-
Disable Preview Branching
Disables 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…
-
Disable Project Readonly Mode
Temporarily disables a Supabase project's read-only mode for 15 minutes to allow write operations (e.g., for maintenance or critical updates), after which it automatically reverts to read-only.
-
Enable Project Database Webhooks
Enables database webhooks for the Supabase project `ref`, triggering real-time notifications for INSERT, UPDATE, or DELETE events.
-
Exchange Auth Code for Access and Refresh Token
(Beta) Implements the OAuth 2.0 token endpoint to exchange an authorization code or refresh token for access/refresh tokens, based on `grant_type`. This is a standard OAuth 2.0 token endpoint that uses…
-
Execute Project Database Query
Executes a given SQL query against the project's database; use for advanced data operations or when standard API endpoints are insufficient, ensuring queries are valid PostgreSQL and sanitized. Use the…
-
Execute Read-Only Database Query
[Beta] Run a SQL query as supabase_read_only_user. Use when you need to safely execute SELECT queries without risk of modifying data. Only read operations are allowed.
-
Generate TypeScript Types
Generates and retrieves TypeScript types from a Supabase project's database; any schemas specified in `included_schemas` must exist in the project.
-
Get a Database Branch
Retrieves 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.
-
Get a Migration
Retrieves 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…
-
Get a Specific SQL Snippet
Retrieves a specific SQL snippet by its unique identifier.
-
Get a SSO Provider by Its UUID
Retrieves the configuration details for a specific Single Sign-On (SSO) provider (e.g., SAML, Google, GitHub, Azure AD), identified by its UUID, within a Supabase project.
-
Get a Third-Party Integration
Retrieves the detailed configuration for a specific third-party authentication (TPA) provider, identified by `tpa_id`, within an existing Supabase project specified by `ref`.
-
Get Action Run Logs
Retrieves 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.
-
Get Action Run Status
Retrieves 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.
-
Get API Health Status
Tool to check the health status of the Supabase API. Use when you need to verify API availability or troubleshoot connectivity issues.
-
Get Available Regions
Tool 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…
-
Get Current Vanity Subdomain Config
Fetches the current vanity subdomain configuration, including its status and custom domain name, for a Supabase project identified by its reference ID.
-
Get Database Branch Config
Retrieves the read-only configuration and status for a Supabase database branch, typically for monitoring or verifying its settings.
-
Get Information About an Organization
Fetches comprehensive details for a specific Supabase organization using its unique slug.
-
Get JIT Access Config
[Beta] Retrieves the project's just-in-time (JIT) access configuration, including user roles and their expiration settings. Use this to check temporary access grants and their validity periods.
-
Get Project
Retrieves detailed information about a specific Supabase project by its unique reference ID. Use when you need to get comprehensive project details including status, database configuration, and metadata…
-
Get Project API Key
Retrieves 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.
-
Get Project API Keys
Retrieves all API keys for an existing Supabase project, specified by its unique reference ID (`ref`); this is a read-only operation.
-
Get Project Auth Config
Retrieves the complete authentication configuration for a Supabase project. Use this action when you need to inspect auth settings, OAuth provider configurations, MFA policies, email/SMS templates, security policies…
-
Get Project Logs
Retrieves analytics logs for a Supabase project. Use this to fetch and analyze project logs including edge function logs, database logs, and API logs for monitoring and debugging.
-
Get Project Network Restrictions
Retrieves the network restriction settings (IP allowlists) for a Supabase project. Use this action to: - Check which IPv4/IPv6 CIDR blocks are allowed to connect to the project's database - Verify if network…
-
Get Project PgBouncer Config
Retrieves the active PgBouncer configuration (PostgreSQL connection pooler) for a Supabase project, used for performance tuning, auditing, or getting the connection string.
-
Get Project Pgsodium Config
Retrieves the PGSodium configuration, including the root encryption key, for an existing Supabase project identified by its `ref`.
-
Get Project Postgres Config
Retrieves the current read-only PostgreSQL database configuration for a specified Supabase project's `ref`, noting that some advanced or security-sensitive details might be omitted from the response.
-
Get Project Signing Keys
Tool to list all signing keys for a Supabase project. Use when you need to retrieve JWT signing keys for authentication verification or rotation management.
-
Get Project SSL Enforcement Configuration
Retrieves the SSL enforcement configuration for a specified Supabase project, indicating if SSL connections are mandated for its database.
-
Get Project Supavisor Configuration
Retrieves the Supavisor (connection pooler) configuration for a specified Supabase project, identified by its reference ID.
-
Get Project Upgrade Eligibility
Checks a Supabase project's eligibility for an upgrade, verifying compatibility and identifying potential issues; this action does not perform the actual upgrade.
-
Get Project Upgrade Status
Retrieves the latest status of a Supabase project's database upgrade for monitoring purposes; does not initiate or modify upgrades.
-
Get Project's Auth Config
Retrieves the project's complete read-only authentication configuration, detailing all settings (e.g., providers, MFA, email/SMS, JWT, security policies) but excluding sensitive secrets.
-
Get Project's PostgREST Config
Retrieves the PostgREST configuration for a specific Supabase project.
-
Get Project's Read-Only Mode Status
Retrieves the read-only mode status for a specified Supabase project to check its operational state; this action does not change the read-only state.
-
Get Project's Service Health Status
Retrieves the current health status for a Supabase project, for specified services or all services if the 'services' list is omitted.
-
Get Table Schemas
Retrieves column details, types, and constraints for multiple database tables to help debug schema issues and write accurate SQL queries. Use the SUPABASE_LIST_TABLES action first to discover available tables, the…
-
Get TUS Resumable Upload Base Options
Handles OPTIONS request for TUS Resumable uploads to discover server capabilities. Use when preparing resumable upload requests to verify supported TUS protocol versions and extensions.
-
Get TUS Resumable Upload Options
Handles OPTIONS request for TUS Resumable uploads to discover server capabilities. Use when preparing resumable upload requests to verify supported TUS protocol versions and extensions.
-
Invoke Edge Function
Tool to invoke a deployed Supabase Edge Function over HTTPS. Use for testing and debugging Edge Functions with configurable method, headers, body, and authentication.
-
List All Buckets
Retrieves a list of all storage buckets for a Supabase project, without returning bucket contents or access policies.
-
List All Database Branches
Lists all database branches for a specified Supabase project, used for isolated development and testing of schema changes; ensure the project reference ID is valid.
-
List All Functions
Lists metadata for all Edge Functions in a Supabase project (specified by 'ref'), excluding function code or logs; the project must exist.
-
List All Organizations
Lists all organizations (ID and name only) associated with the Supabase account, excluding project details within these organizations.
-
List All Projects
Retrieves a list of all Supabase projects, including their ID, name, region, and status, for the authenticated user. Authentication: - Requires a valid Bearer token in the Authorization header. - Token format: 'Bearer…
-
List All Secrets
Retrieves all secrets for a Supabase project using its reference ID; secret values in the response may be masked.
-
List All SSO Providers
Lists all configured Single Sign-On (SSO) providers for a Supabase project, requiring the project reference ID (`ref`) of an existing project.
-
List Database Branches
Lists 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…
-
List Database Tables
Lists all tables and views in specified database schemas, providing a quick overview of database structure to help identify available tables before fetching detailed schemas.
-
List Members of an Organization
Retrieves all members of a Supabase organization, identified by its unique slug, including their user ID, username, email, role, and MFA status.
-
List Migration History
Retrieves the list of applied database migration versions for a Supabase project. Use this to track which migrations have been applied to the project's database. This is a read-only operation that requires the project…
-
List Project Database Backups
Lists all database backups for a Supabase project, providing details on existing backups but not creating new ones or performing restores; availability may depend on plan and configuration.
-
List Project Secrets
Retrieves 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…
-
List SQL Snippets for the Logged in User
Retrieves a list of SQL snippets for the logged-in user, optionally filtered by a specific Supabase project if `project_ref` is provided.
-
List Third-Party Auth Integrations for Project
Lists all configured third-party authentication provider integrations for an existing Supabase project (using its `ref`), suitable for read-only auditing or verifying current authentication settings.
-
Merge a Database Branch
Merges a database branch, applying all schema changes and migrations from the branch to the target database. Use this action when you need to promote changes from a database branch to production or another target…
-
OPTIONS for Resumable Upload Sign
Handles CORS preflight OPTIONS request for TUS resumable upload signing. Use when preparing cross-origin resumable upload requests to verify allowed methods and headers.
-
OPTIONS for Resumable Upload Sign
Handles CORS preflight OPTIONS request for TUS resumable upload signing endpoints. Use when preparing cross-origin resumable upload requests to verify allowed methods and headers.
-
Patch a 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.
-
Patch Project Network Restrictions
Updates project's network restrictions by incrementally adding or removing IPv4/IPv6 CIDR blocks. Use when you need to modify existing restrictions without replacing the entire configuration.
-
Push a Database Branch
Pushes a database branch, applying migrations and changes to the specified branch. Use when you need to deploy schema changes or migrations to a database branch.
-
Remove an SSO Provider
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.
-
Remove Project Network Bans
Removes specified IPv4 addresses from a Supabase project's network ban list, granting immediate access; IPs not currently banned are ignored.
-
Remove Read Replica
Remove a read replica from a Supabase project (Pro plan or higher required). This beta endpoint initiates the removal of a specified read replica database. The operation is irreversible. Before removal, ensure all…
-
Reset a Database Branch
Resets an existing Supabase database branch, identified by `branch_id`, to its initial clean state, irreversibly deleting all its current data and schema changes.
-
Restore Database PITR Backup
Restores a Supabase project's database to a specific Unix timestamp using Point-in-Time Recovery (PITR), overwriting the current state; requires a paid plan with PITR and physical backups enabled.
-
Retrieve a Function
Retrieves detailed information, metadata, configuration, and status for a specific Edge Function using its project reference ID and function slug.
-
Retrieve a Function Body
Retrieves the source code (body) for a specified serverless Edge Function using its project reference and function slug; this is a read-only operation that does not execute the function or return runtime logs.
-
Retrieve Network Bans for Project
Retrieves the list of banned IPv4 addresses for a Supabase project using its unique project reference string; this is a read-only operation.
-
Reverify Custom Hostname
Re-verifies DNS and SSL configurations for an existing custom hostname associated with a Supabase project.
-
Select From Table
Tool to select rows from a Supabase/PostgREST table. Use for read-only queries with filtering, sorting, and pagination.
-
Setup Read Replica for Project
Provisions a read-only replica for a Supabase project in a specified, Supabase-supported AWS region to enhance read performance and reduce latency.
-
Update a Function
Updates an existing Supabase Edge Function's properties (like name, slug, source code, JWT settings, import map) identified by project `ref` and `function_slug`, supporting plain text code or ESZIP for the body. Use…
-
Update a Project
Updates a Supabase project's configuration (currently supports updating the project name). Use when you need to rename an existing project.
-
Update an API Key for the Project
Updates an existing Supabase project API key's `description` and/or `secret_jwt_template` (which defines its `role`); does not regenerate the key string.
-
Update an SSO Provider by Its UUID
Updates an existing SSO provider's SAML metadata, associated email domains, or attribute mappings for a Supabase project, identified by `ref` and `provider_id`.
-
Update API Key
Updates an existing Supabase project API key's metadata including name, description, and JWT template configuration. This action modifies key properties without regenerating the actual key value. Use this action when…
-
Update Branch Configuration
Updates 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…
-
Update Database Branch Config
Updates the configuration of a Supabase database branch, allowing modification of its name, associated Git branch, reset-on-push behavior, persistence, and status. Note: Database branching requires a paid Supabase plan…
-
Update Database Password
Updates the database password for a Supabase project. Use when needing to rotate credentials or recover database access.
-
Update Database Pooler Config
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.
-
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.
-
Update Pgsodium Root Key
Critically updates or initializes a Supabase project's pgsodium root encryption key for security setup or key rotation, requiring secure backup of the new key to prevent irreversible data loss.
-
Update Project Legacy API Keys
Tool to disable or re-enable JWT-based legacy API keys (anon, service_role) for a Supabase project. Use when you need to toggle legacy API key access for security or migration purposes. Note: This API endpoint may be…
-
Update Project's Auth Config
Update 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…
-
Update Project's Custom Hostname Configuration
Updates the custom hostname for a Supabase project, requiring subsequent DNS changes to a user-controlled domain for SSL certificate issuance and domain ownership.
-
Update Project's Postgres Config
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…
-
Update Project's PostgREST Config
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.
-
Update SSL Enforcement Config
Updates the SSL enforcement configuration (enable/disable) for a specified Supabase project's database.
-
Upgrade the Project's PostgreSQL Version
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…
-
Upsert Migration
Tool 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.
Setup
Connect Supabase in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
