Manage Supabase organizations, projects, database operations, authentication settings, storage configuration and functions with the official Management API. Use a scoped personal access token for only the resources and permissions you need.
Example workflows
Copy a prompt into your connected AI client after connecting this integration. Choose resources you can access and review the supported command before running it.
Get database branch config
Help me with this task in Supabase: Get database branch config. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: supabase.v1-get-a-branch-config
Diffs a database branch
Help me with this task in Supabase: Diffs a database branch. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: supabase.v1-diff-a-branch
What you can do (164)
What you can do
Available commands: 164 (76 read, 88 write). Enable only the commands your application needs.
| Command | Effect |
|---|---|
Get database branch config — supabase.v1-get-a-branch-config |
Read |
Update database branch config — supabase.v1-update-a-branch-config |
Write |
Delete a database branch — supabase.v1-delete-a-branch |
Write |
Pushes a database branch — supabase.v1-push-a-branch |
Write |
Merges a database branch — supabase.v1-merge-a-branch |
Write |
Resets a database branch — supabase.v1-reset-a-branch |
Write |
Restore a scheduled branch deletion — supabase.v1-restore-a-branch |
Write |
Diffs a database branch — supabase.v1-diff-a-branch |
Read |
List all projects — supabase.v1-list-all-projects |
Read |
Create a project — supabase.v1-create-a-project |
Write |
Gets the list of available regions that can be used for a new project — supabase.v1-get-available-regions |
Read |
List all organizations — supabase.v1-list-all-organizations |
Read |
Create an organization — supabase.v1-create-an-organization |
Write |
Authorize user through oauth — supabase.v1-authorize-user |
Read |
Revoke oauth app authorization and it's corresponding tokens — supabase.v1-revoke-token |
Write |
Authorize user through oauth and claim a project — supabase.v1-oauth-authorize-project-claim |
Read |
Lists SQL snippets for the logged in user — supabase.v1-list-all-snippets |
Read |
Gets a specific SQL snippet — supabase.v1-get-a-snippet |
Read |
Gets the user's profile — supabase.v1-get-profile |
Read |
Count the number of action runs — supabase.v1-count-action-runs |
Read |
List all action runs — supabase.v1-list-action-runs |
Read |
Get the status of an action run — supabase.v1-get-action-run |
Read |
Update the status of an action run — supabase.v1-update-action-run-status |
Write |
Get the logs of an action run — supabase.v1-get-action-run-logs |
Read |
Get project api keys — supabase.v1-get-project-api-keys |
Read |
Creates a new API key for the project — supabase.v1-create-project-api-key |
Write |
Check whether JWT based legacy (anon, service_role) API keys are enabled. This API endpoint will be removed in the futur — supabase.v1-get-project-legacy-api-keys |
Read |
Disable or re-enable JWT based legacy (anon, service_role) API keys. This API endpoint will be removed in the future, ch — supabase.v1-update-project-legacy-api-keys |
Write |
Updates an API key for the project — supabase.v1-update-project-api-key |
Write |
Get API key — supabase.v1-get-project-api-key |
Read |
Deletes an API key for the project — supabase.v1-delete-project-api-key |
Write |
List all database branches — supabase.v1-list-all-branches |
Read |
Create a database branch — supabase.v1-create-a-branch |
Write |
Disables preview branching — supabase.v1-disable-preview-branching |
Write |
Get a database branch — supabase.v1-get-a-branch |
Read |
Gets project's custom hostname config — supabase.v1-get-hostname-config |
Read |
Deletes a project's custom hostname configuration — supabase.v1-delete-hostname-config |
Write |
Updates project's custom hostname configuration — supabase.v1-update-hostname-config |
Write |
Attempts to verify the DNS configuration for project's custom hostname configuration — supabase.v1-verify-dns-config |
Write |
Activates a custom hostname for a project. — supabase.v1-activate-custom-hostname |
Write |
Get project's temporary access configuration. — supabase.v1-get-jit-access-config |
Read |
Update project's temporary access configuration. — supabase.v1-update-jit-access-config |
Write |
Gets project's network bans — supabase.v1-list-all-network-bans |
Write |
Gets project's network bans with additional information about which databases they affect — supabase.v1-list-all-network-bans-enriched |
Write |
Remove network bans. — supabase.v1-delete-network-bans |
Write |
Gets project's network restrictions — supabase.v1-get-network-restrictions |
Read |
Updates project's network restrictions by adding or removing CIDRs — supabase.v1-patch-network-restrictions |
Write |
Updates project's network restrictions — supabase.v1-update-network-restrictions |
Write |
Gets project's pgsodium config — supabase.v1-get-pgsodium-config |
Read |
Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inacc — supabase.v1-update-pgsodium-config |
Write |
Gets project's postgrest config — supabase.v1-get-postgrest-service-config |
Read |
Updates project's postgrest config — supabase.v1-update-postgrest-service-config |
Write |
Gets a specific project that belongs to the authenticated user — supabase.v1-get-project |
Read |
Deletes the given project — supabase.v1-delete-a-project |
Write |
Updates the given project — supabase.v1-update-a-project |
Write |
List all secrets — supabase.v1-list-all-secrets |
Read |
Bulk create secrets — supabase.v1-bulk-create-secrets |
Write |
Bulk delete secrets — supabase.v1-bulk-delete-secrets |
Write |
Get project's SSL enforcement configuration. — supabase.v1-get-ssl-enforcement-config |
Read |
Update project's SSL enforcement configuration. — supabase.v1-update-ssl-enforcement-config |
Write |
Generate TypeScript types — supabase.v1-generate-typescript-types |
Read |
Gets current vanity subdomain config — supabase.v1-get-vanity-subdomain-config |
Read |
Deletes a project's vanity subdomain configuration — supabase.v1-deactivate-vanity-subdomain-config |
Write |
Checks vanity subdomain availability — supabase.v1-check-vanity-subdomain-availability |
Write |
Activates a vanity subdomain for a project. — supabase.v1-activate-vanity-subdomain-config |
Write |
Upgrades the project's Postgres version — supabase.v1-upgrade-postgres-version |
Write |
Returns the project's eligibility for upgrades — supabase.v1-get-postgres-upgrade-eligibility |
Read |
Gets the latest status of the project's upgrade — supabase.v1-get-postgres-upgrade-status |
Read |
Returns project's readonly mode status — supabase.v1-get-readonly-mode-status |
Read |
Disables project's readonly mode for the next 15 minutes — supabase.v1-disable-readonly-mode-temporarily |
Write |
Set up a read replica — supabase.v1-setup-a-read-replica |
Write |
Remove a read replica — supabase.v1-remove-a-read-replica |
Write |
Set up the project's existing JWT secret as an in_use JWT signing key. This endpoint will be removed in the future alway — supabase.v1-create-legacy-signing-key |
Write |
Get the signing key information for the JWT secret imported as signing key for this project. This endpoint will be remov — supabase.v1-get-legacy-signing-key |
Read |
Create a new signing key for the project in standby status — supabase.v1-create-project-signing-key |
Write |
List all signing keys for the project — supabase.v1-get-project-signing-keys |
Read |
Get information about a signing key — supabase.v1-get-project-signing-key |
Read |
Remove a signing key from a project. Only possible if the key has been in revoked status for a while. — supabase.v1-remove-project-signing-key |
Write |
Update a signing key, mainly its status — supabase.v1-update-project-signing-key |
Write |
Gets project's auth config — supabase.v1-get-auth-service-config |
Read |
Updates a project's auth config — supabase.v1-update-auth-service-config |
Write |
Creates a new third-party auth integration — supabase.v1-create-project-tpa-integration |
Write |
Lists all third-party auth integrations — supabase.v1-list-project-tpa-integrations |
Read |
Removes a third-party auth integration — supabase.v1-delete-project-tpa-integration |
Write |
Get a third-party integration — supabase.v1-get-project-tpa-integration |
Read |
Pauses the given project — supabase.v1-pause-a-project |
Write |
Restarts the given project — supabase.v1-restart-a-project |
Write |
Lists available restore versions for the given project — supabase.v1-list-available-restore-versions |
Read |
Restores the given project — supabase.v1-restore-a-project |
Write |
Cancels the given project restoration — supabase.v1-cancel-a-project-restoration |
Write |
List billing addons and compute instance selections — supabase.v1-list-project-addons |
Read |
Apply or update billing addons, including compute instance size — supabase.v1-apply-project-addon |
Write |
Remove billing addons or revert compute instance sizing — supabase.v1-remove-project-addon |
Write |
Gets project claim token — supabase.v1-get-project-claim-token |
Read |
Creates project claim token — supabase.v1-create-project-claim-token |
Write |
Revokes project claim token — supabase.v1-delete-project-claim-token |
Write |
Gets project performance advisors. — supabase.v1-get-performance-advisors |
Read |
Gets project security advisors. — supabase.v1-get-security-advisors |
Read |
Gets all project's logs in a single log stream — supabase.v1-get-project-logs |
Read |
Gets project's usage api counts — supabase.v1-get-project-usage-api-count |
Read |
Gets project's usage api requests count — supabase.v1-get-project-usage-request-count |
Read |
Gets a project's function combined statistics — supabase.v1-get-project-function-combined-stats |
Read |
Scrape a project's metrics — supabase.v1-scrape-project-metrics |
Read |
Create a login role for CLI with temporary password — supabase.v1-create-login-role |
Write |
Delete existing login roles used by CLI — supabase.v1-delete-login-roles |
Write |
List applied migration versions — supabase.v1-list-migration-history |
Read |
Apply a database migration — supabase.v1-apply-a-migration |
Write |
Upsert a database migration without applying — supabase.v1-upsert-a-migration |
Write |
Rollback database migrations and remove them from history table — supabase.v1-rollback-migrations |
Write |
Fetch an existing entry from migration history — supabase.v1-get-a-migration |
Read |
Patch an existing entry in migration history — supabase.v1-patch-a-migration |
Write |
Run sql query — supabase.v1-run-a-query |
Write |
Run a sql query as supabase_read_only_user — supabase.v1-read-only-query |
Write |
Enables Database Webhooks on the project — supabase.v1-enable-database-webhook |
Write |
Gets database metadata for the given project. — supabase.v1-get-database-metadata |
Read |
Updates the database password — supabase.v1-update-database-password |
Write |
Get user-id to role mappings for JIT access — supabase.v1-get-jit-access |
Read |
Authorize user-id to role mappings for JIT access — supabase.v1-authorize-jit-access |
Write |
Updates a user mapping for JIT access — supabase.v1-update-jit-access |
Write |
List all user-id to role mappings for JIT access — supabase.v1-list-jit-access |
Read |
Invites an external user to a database for JIT access — supabase.v1-invite-external-jit-access |
Write |
Deletes the invite for an external user to a database for JIT access — supabase.v1-delete-invite-external-jit-access |
Write |
Delete JIT access by user-id — supabase.v1-delete-jit-access |
Write |
Get PostgREST OpenAPI spec — supabase.v1-get-database-openapi |
Read |
List all functions — supabase.v1-list-all-functions |
Read |
Bulk update functions — supabase.v1-bulk-update-functions |
Write |
Retrieve a function — supabase.v1-get-a-function |
Read |
Update a function — supabase.v1-update-a-function |
Write |
Delete a function — supabase.v1-delete-a-function |
Write |
Retrieve a function body — supabase.v1-get-a-function-body |
Read |
Lists all buckets — supabase.v1-list-all-buckets |
Read |
Get database disk attributes — supabase.v1-get-database-disk |
Read |
Modify database disk — supabase.v1-modify-database-disk |
Write |
Get disk utilization — supabase.v1-get-disk-utilization |
Read |
Gets project disk autoscale config — supabase.v1-get-project-disk-autoscale-config |
Read |
Gets project's storage config — supabase.v1-get-storage-config |
Read |
Updates project's storage config — supabase.v1-update-storage-config |
Write |
Get project's pgbouncer config — supabase.v1-get-project-pgbouncer-config |
Read |
Gets project's supavisor config — supabase.v1-get-pooler-config |
Read |
Updates project's supavisor config — supabase.v1-update-pooler-config |
Write |
Gets project's Postgres config — supabase.v1-get-postgres-config |
Read |
Updates project's Postgres config — supabase.v1-update-postgres-config |
Write |
Gets realtime configuration — supabase.v1-get-realtime-config |
Read |
Updates realtime configuration — supabase.v1-update-realtime-config |
Write |
Shutdowns realtime connections for a project — supabase.v1-shutdown-realtime |
Write |
Creates a new SSO provider — supabase.v1-create-a-sso-provider |
Write |
Lists all SSO providers — supabase.v1-list-all-sso-provider |
Read |
Gets a SSO provider by its UUID — supabase.v1-get-a-sso-provider |
Read |
Updates a SSO provider by its UUID — supabase.v1-update-a-sso-provider |
Write |
Removes a SSO provider by its UUID — supabase.v1-delete-a-sso-provider |
Write |
Lists all backups — supabase.v1-list-all-backups |
Read |
Restores a PITR backup for a database — supabase.v1-restore-pitr-backup |
Write |
Initiates a creation of a restore point for a database — supabase.v1-create-restore-point |
Write |
Get restore points for project — supabase.v1-get-restore-point |
Read |
Restores a physical backup for a database — supabase.v1-restore-physical-backup |
Write |
Gets the backup schedule for a project — supabase.v1-get-backup-schedule |
Read |
Updates the backup schedule time for a project — supabase.v1-update-backup-schedule |
Write |
Initiates an undo to a given restore point — supabase.v1-undo |
Write |
Get entitlements for an organization — supabase.v1-get-organization-entitlements |
Read |
List members of an organization — supabase.v1-list-organization-members |
Read |
Gets information about the organization — supabase.v1-get-an-organization |
Read |
Gets project details for the specified organization and claim token — supabase.v1-get-organization-project-claim |
Read |
Claims project for the specified organization — supabase.v1-claim-project-for-organization |
Write |
Gets all projects for the given organization — supabase.v1-get-all-projects-for-organization |
Read |
Connect and use
This connection uses your provider account.
Connect this integration, enter your provider credentials, choose commands and save. Complete provider authorization if prompted.
Get your provider credentials
Follow these steps for Supabase, then enter the issued values in the connection form below.
- In the Supabase dashboard, open Account preferences → Access tokens and generate a personal access token. Restrict its resources, permissions and expiry where supported; start with read-only access. Paste it into this connection’s Supabase personal access token field. This is a Management API token, not a project anon, publishable or service_role key. Choose commands and save, then create a separate Tooluse.net API key for your client. Project changes and SQL execution can affect data and billing.
Where to enter credentials
In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.
| Connection field | Requirement |
|---|---|
| Supabase personal access token | Required |
Open API keys and create a Tooluse.net key for the enabled commands.
Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.
Configure Claude Code, Codex or Cursor once
Permissions and results
If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.
Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.
Call from your client
Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.
Configure Claude Code, Codex or Cursor once
Discover your enabled tools
List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.
curl 'https://api.tooluse.net/v1/tools' \
-H "Authorization: Bearer $TOOLUSE_API_KEY"
Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.
HTTP call
curl 'https://api.tooluse.net/v1/tool-calls' \
-H "Authorization: Bearer $TOOLUSE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: replace-with-a-new-call-id' \
--data '{
"type": "tool_use",
"id": "toolu_example",
"name": "svc_FROM_YOUR_TOOL_LIST",
"input": {
"path": {
"branch_id_or_ref": "abcdefghijklmnopqrst"
}
}
}'
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Commands
Get database branch config — supabase.v1-get-a-branch-config
Fetches configurations of the specified database branch
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.branch_id_or_ref |
— | Required | Branch ref or deprecated branch ID | |
path.branch_id_or_ref |
string | Required | Project ref | anyOf[1]; minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.branch_id_or_ref |
string | Required | anyOf[2]; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"branch_id_or_ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update database branch config — supabase.v1-update-a-branch-config
Updates the configuration of the specified database branch
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.branch_id_or_ref |
— | Required | Branch ref or deprecated branch ID | |
path.branch_id_or_ref |
string | Required | Project ref | anyOf[1]; minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.branch_id_or_ref |
string | Required | anyOf[2]; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
body |
— | Required | $ref: "#/definitions/UpdateBranchBody" |
Full JSON Schema
Example input
{
"path": {
"branch_id_or_ref": "abcdefghijklmnopqrst"
},
"body": {
"branch_name": "preview-login-page",
"git_branch": "feature/login-page",
"persistent": true,
"request_review": true,
"notify_url": "https://example.com/webhooks/branches"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a database branch — supabase.v1-delete-a-branch
Deletes the specified database branch. By default, deletes immediately. Use force=false to schedule deletion with 1-hour grace period (only when soft deletion is enabled).
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.branch_id_or_ref |
— | Required | Branch ref or deprecated branch ID | |
path.branch_id_or_ref |
string | Required | Project ref | anyOf[1]; minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.branch_id_or_ref |
string | Required | anyOf[2]; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
query |
object | Optional | additionalProperties: false |
|
query.force |
string | Optional | If set to false, schedule deletion with 1-hour grace period (only when soft deletion is enabled). |
Full JSON Schema
Example input
{
"path": {
"branch_id_or_ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Pushes a database branch — supabase.v1-push-a-branch
Pushes the specified database branch
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.branch_id_or_ref |
— | Required | Branch ref or deprecated branch ID | |
path.branch_id_or_ref |
string | Required | Project ref | anyOf[1]; minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.branch_id_or_ref |
string | Required | anyOf[2]; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
body |
— | Required | $ref: "#/definitions/BranchActionBody" |
Full JSON Schema
Example input
{
"path": {
"branch_id_or_ref": "abcdefghijklmnopqrst"
},
"body": {
"migration_version": "20250312000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Merges a database branch — supabase.v1-merge-a-branch
Merges the specified database branch
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.branch_id_or_ref |
— | Required | Branch ref or deprecated branch ID | |
path.branch_id_or_ref |
string | Required | Project ref | anyOf[1]; minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.branch_id_or_ref |
string | Required | anyOf[2]; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
body |
— | Required | $ref: "#/definitions/BranchActionBody" |
Full JSON Schema
Example input
{
"path": {
"branch_id_or_ref": "abcdefghijklmnopqrst"
},
"body": {
"migration_version": "20250312000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Resets a database branch — supabase.v1-reset-a-branch
Resets the specified database branch
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.branch_id_or_ref |
— | Required | Branch ref or deprecated branch ID | |
path.branch_id_or_ref |
string | Required | Project ref | anyOf[1]; minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.branch_id_or_ref |
string | Required | anyOf[2]; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
body |
— | Required | $ref: "#/definitions/BranchActionBody" |
Full JSON Schema
Example input
{
"path": {
"branch_id_or_ref": "abcdefghijklmnopqrst"
},
"body": {
"migration_version": "20250312000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Restore a scheduled branch deletion — supabase.v1-restore-a-branch
Cancels scheduled deletion and restores the branch to active state
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.branch_id_or_ref |
— | Required | Branch ref or deprecated branch ID | |
path.branch_id_or_ref |
string | Required | Project ref | anyOf[1]; minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.branch_id_or_ref |
string | Required | anyOf[2]; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"branch_id_or_ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Diffs a database branch — supabase.v1-diff-a-branch
Diffs the specified database branch
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.branch_id_or_ref |
— | Required | Branch ref or deprecated branch ID | |
path.branch_id_or_ref |
string | Required | Project ref | anyOf[1]; minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.branch_id_or_ref |
string | Required | anyOf[2]; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
query |
object | Optional | additionalProperties: false |
|
query.included_schemas |
string | Optional | ||
query.pgdelta |
string | Optional | Use pg-delta instead of Migra for diffing when true. Boolean string. Truthy values: true, 1, yes, on, y, enabled Falsy values: false, 0, no, off, n, disabled |
Full JSON Schema
Example input
{
"path": {
"branch_id_or_ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all projects — supabase.v1-list-all-projects
Returns a list of all projects you've previously created.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a project — supabase.v1-create-a-project
Create a project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/V1CreateProjectBody" |
Full JSON Schema
Example input
{
"body": {
"db_pass": "correct-horse-battery-staple",
"name": "acme-prod",
"organization_slug": "tsrqponmlkjihgfedcba",
"region": "us-east-1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets the list of available regions that can be used for a new project — supabase.v1-get-available-regions
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.organization_slug |
string | Required | Slug of your organization | |
query.continent |
string | Optional | Continent code to determine regional recommendations: NA (North America), SA (South America), EU (Europe), AF (Africa), AS (Asia), OC (Oceania), AN (Antarctica) | enum: ["NA","SA","EU","AF","AS","OC","AN"] |
query.desired_instance_size |
string | Optional | Desired instance size. Omit this field to always default to the smallest possible size. | enum: ["nano","micro","small","medium","large","xlarge","2xlarge","4xlarge","8xlarge","12xlarge","16xlarge","24xlarge","24xlarge_optimized_memory","24xlarge_optimized_cpu","24xlarge_high_memory","48xlarge","48xlarge_optimized_memory","48xlarge_optimized_cpu","48xlarge_high_memory"] |
Full JSON Schema
Example input
{
"query": {
"organization_slug": "tsrqponmlkjihgfedcba"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all organizations — supabase.v1-list-all-organizations
Returns a list of organizations that you currently belong to.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an organization — supabase.v1-create-an-organization
Create an organization
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/CreateOrganizationV1" |
Full JSON Schema
Example input
{
"body": {
"name": "Acme"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Revoke oauth app authorization and it's corresponding tokens — supabase.v1-revoke-token
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/OAuthRevokeTokenBody" |
Full JSON Schema
Example input
{
"body": {
"client_id": "66666666-6666-4666-8666-666666666666",
"client_secret": "sb_secret_live_example_9f4d3a206b2e4a7e8c91",
"refresh_token": "oauth_refresh_9f4d3a206b2e4a7e8c91"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Lists SQL snippets for the logged in user — supabase.v1-list-all-snippets
Lists SQL snippets for the logged in user
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.project_ref |
string | Optional | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query.cursor |
string | Optional | ||
query.limit |
string | Optional | minimum: 1; maximum: 100 |
|
query.sort_by |
string | Optional | enum: ["name","inserted_at"] |
|
query.sort_order |
string | Optional | enum: ["asc","desc"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets a specific SQL snippet — supabase.v1-get-a-snippet
Gets a specific SQL snippet
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"id": "44444444-4444-4444-8444-444444444444"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets the user's profile — supabase.v1-get-profile
Gets the user's profile
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Count the number of action runs — supabase.v1-count-action-runs
Returns the total number of action runs of the specified project.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all action runs — supabase.v1-list-action-runs
Returns a paginated list of action runs of the specified project.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.offset |
number | Optional | minimum: 0 |
|
query.limit |
number | Optional | minimum: 10 |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get the status of an action run — supabase.v1-get-action-run
Returns the current status of the specified action run.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.run_id |
string | Required | Action Run ID |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"run_id": "run_01hq3q9m7y5q7e4a7x2c8m1p4n"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update the status of an action run — supabase.v1-update-action-run-status
Updates the status of an ongoing action run.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.run_id |
string | Required | Action Run ID | |
body |
— | Required | $ref: "#/definitions/UpdateRunStatusBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"run_id": "run_01hq3q9m7y5q7e4a7x2c8m1p4n"
},
"body": {
"clone": "RUNNING",
"configure": "RUNNING",
"migrate": "RUNNING",
"deploy": "CREATED"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get the logs of an action run — supabase.v1-get-action-run-logs
Returns the logs from the specified action run.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.run_id |
string | Required | Action Run ID |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"run_id": "run_01hq3q9m7y5q7e4a7x2c8m1p4n"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get project api keys — supabase.v1-get-project-api-keys
Get project api keys
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.reveal |
string | Optional | Boolean string. Truthy values: true, 1, yes, on, y, enabled Falsy values: false, 0, no, off, n, disabled |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Creates a new API key for the project — supabase.v1-create-project-api-key
Creates a new API key for the project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.reveal |
string | Optional | Boolean string. Truthy values: true, 1, yes, on, y, enabled Falsy values: false, 0, no, off, n, disabled |
|
body |
— | Required | $ref: "#/definitions/CreateApiKeyBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"type": "secret",
"name": "ci_secret_key",
"description": "CI deploy key"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Check whether JWT based legacy (anon, service_role) API keys are enabled. This API endpoint will be removed in the futur — supabase.v1-get-project-legacy-api-keys
Check whether JWT based legacy (anon, service_role) API keys are enabled. This API endpoint will be removed in the future, check for HTTP 404 Not Found.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Disable or re-enable JWT based legacy (anon, service_role) API keys. This API endpoint will be removed in the future, ch — supabase.v1-update-project-legacy-api-keys
Disable or re-enable JWT based legacy (anon, service_role) API keys. This API endpoint will be removed in the future, check for HTTP 404 Not Found.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Required | additionalProperties: false |
|
query.enabled |
string | Required | Boolean string. Truthy values: true, 1, yes, on, y, enabled Falsy values: false, 0, no, off, n, disabled |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"query": {
"enabled": "true"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates an API key for the project — supabase.v1-update-project-api-key
Updates an API key for the project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
query |
object | Optional | additionalProperties: false |
|
query.reveal |
string | Optional | Boolean string. Truthy values: true, 1, yes, on, y, enabled Falsy values: false, 0, no, off, n, disabled |
|
body |
— | Required | $ref: "#/definitions/UpdateApiKeyBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"id": "22222222-2222-4222-8222-222222222222"
},
"body": {
"name": "ci_secret_key_rotated",
"description": "Rotated after March release"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get API key — supabase.v1-get-project-api-key
Get API key
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
query |
object | Optional | additionalProperties: false |
|
query.reveal |
string | Optional | Boolean string. Truthy values: true, 1, yes, on, y, enabled Falsy values: false, 0, no, off, n, disabled |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"id": "22222222-2222-4222-8222-222222222222"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Deletes an API key for the project — supabase.v1-delete-project-api-key
Deletes an API key for the project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
query |
object | Optional | additionalProperties: false |
|
query.reveal |
string | Optional | Boolean string, true or false | |
query.was_compromised |
string | Optional | Boolean string, true or false | |
query.reason |
string | Optional |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"id": "22222222-2222-4222-8222-222222222222"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all database branches — supabase.v1-list-all-branches
Returns all database branches of the specified project.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a database branch — supabase.v1-create-a-branch
Creates a database branch from the specified project.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/CreateBranchBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"branch_name": "preview-login-page",
"git_branch": "feature/login-page",
"persistent": true,
"with_data": false,
"notify_url": "https://example.com/webhooks/branches"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Disables preview branching — supabase.v1-disable-preview-branching
Disables preview branching for the specified project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a database branch — supabase.v1-get-a-branch
Fetches the specified database branch by its name.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.name |
string | Required |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"name": "preview-login-page"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's custom hostname config — supabase.v1-get-hostname-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Deletes a project's custom hostname configuration — supabase.v1-delete-hostname-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.remove_addon |
string | Optional | If true, also removes the custom domain add-on from the project subscription. |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates project's custom hostname configuration — supabase.v1-update-hostname-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpdateCustomHostnameBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"custom_hostname": "docs.example.com"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Attempts to verify the DNS configuration for project's custom hostname configuration — supabase.v1-verify-dns-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Activates a custom hostname for a project. — supabase.v1-activate-custom-hostname
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get project's temporary access configuration. — supabase.v1-get-jit-access-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update project's temporary access configuration. — supabase.v1-update-jit-access-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/JitAccessRequestRequest" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"state": "enabled"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's network bans — supabase.v1-list-all-network-bans
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's network bans with additional information about which databases they affect — supabase.v1-list-all-network-bans-enriched
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove network bans. — supabase.v1-delete-network-bans
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/RemoveNetworkBanRequest" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"ipv4_addresses": [
"203.0.113.10"
],
"requester_ip": false
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's network restrictions — supabase.v1-get-network-restrictions
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates project's network restrictions by adding or removing CIDRs — supabase.v1-patch-network-restrictions
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/NetworkRestrictionsPatchRequest" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"add": {
"dbAllowedCidrs": [
"203.0.113.0/24"
]
},
"remove": {
"dbAllowedCidrs": [
"198.51.100.0/24"
]
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates project's network restrictions — supabase.v1-update-network-restrictions
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/NetworkRestrictionsRequest" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"dbAllowedCidrs": [
"203.0.113.0/24"
],
"dbAllowedCidrsV6": [
"2001:db8::/32"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's pgsodium config — supabase.v1-get-pgsodium-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inacc — supabase.v1-update-pgsodium-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpdatePgsodiumConfigBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"root_key": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's postgrest config — supabase.v1-get-postgrest-service-config
Gets project's postgrest config
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates project's postgrest config — supabase.v1-update-postgrest-service-config
Updates project's postgrest config
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1UpdatePostgrestConfigBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"db_schema": "public,storage",
"db_pool": 20,
"max_rows": 1000
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets a specific project that belongs to the authenticated user — supabase.v1-get-project
Gets a specific project that belongs to the authenticated user
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Deletes the given project — supabase.v1-delete-a-project
Deletes the given project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates the given project — supabase.v1-update-a-project
Updates the given project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1UpdateProjectBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"name": "Acme Platform"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all secrets — supabase.v1-list-all-secrets
Returns all secrets you've previously added to the specified project.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk create secrets — supabase.v1-bulk-create-secrets
Creates multiple secrets and adds them to the specified project.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/CreateSecretBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": [
{
"name": "OPENAI_API_KEY",
"value": "sk-example-secret"
},
{
"name": "STRIPE_WEBHOOK_SECRET",
"value": "whsec_example"
}
]
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk delete secrets — supabase.v1-bulk-delete-secrets
Deletes all secrets with the given names from the specified project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/DeleteSecretsBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": [
"OPENAI_API_KEY"
]
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get project's SSL enforcement configuration. — supabase.v1-get-ssl-enforcement-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update project's SSL enforcement configuration. — supabase.v1-update-ssl-enforcement-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/SslEnforcementRequest" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"requestedConfig": {
"database": true
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Generate TypeScript types — supabase.v1-generate-typescript-types
Returns the TypeScript types of your schema for use with supabase-js.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.included_schemas |
string | Optional | default: "public" |
|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets current vanity subdomain config — supabase.v1-get-vanity-subdomain-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Deletes a project's vanity subdomain configuration — supabase.v1-deactivate-vanity-subdomain-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Checks vanity subdomain availability — supabase.v1-check-vanity-subdomain-availability
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/VanitySubdomainBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"vanity_subdomain": "acme-prod"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Activates a vanity subdomain for a project. — supabase.v1-activate-vanity-subdomain-config
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/VanitySubdomainBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"vanity_subdomain": "acme-prod"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Upgrades the project's Postgres version — supabase.v1-upgrade-postgres-version
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpgradeDatabaseBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"target_version": "17",
"release_channel": "ga"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Returns the project's eligibility for upgrades — supabase.v1-get-postgres-upgrade-eligibility
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets the latest status of the project's upgrade — supabase.v1-get-postgres-upgrade-status
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.tracking_id |
string | Optional |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Returns project's readonly mode status — supabase.v1-get-readonly-mode-status
Returns project's readonly mode status
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Disables project's readonly mode for the next 15 minutes — supabase.v1-disable-readonly-mode-temporarily
Disables project's readonly mode for the next 15 minutes
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Set up a read replica — supabase.v1-setup-a-read-replica
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/SetUpReadReplicaBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"read_replica_region": "us-west-1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a read replica — supabase.v1-remove-a-read-replica
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/RemoveReadReplicaBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"database_identifier": "abcdefghijklmnopqrst-rr-us-west-1-abcde"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Set up the project's existing JWT secret as an in_use JWT signing key. This endpoint will be removed in the future alway — supabase.v1-create-legacy-signing-key
Set up the project's existing JWT secret as an in_use JWT signing key. This endpoint will be removed in the future always check for HTTP 404 Not Found.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get the signing key information for the JWT secret imported as signing key for this project. This endpoint will be remov — supabase.v1-get-legacy-signing-key
Get the signing key information for the JWT secret imported as signing key for this project. This endpoint will be removed in the future, check for HTTP 404 Not Found.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new signing key for the project in standby status — supabase.v1-create-project-signing-key
Create a new signing key for the project in standby status
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/CreateSigningKeyBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"algorithm": "RS256",
"status": "standby"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all signing keys for the project — supabase.v1-get-project-signing-keys
List all signing keys for the project
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get information about a signing key — supabase.v1-get-project-signing-key
Get information about a signing key
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"id": "33333333-3333-4333-8333-333333333333",
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a signing key from a project. Only possible if the key has been in revoked status for a while. — supabase.v1-remove-project-signing-key
Remove a signing key from a project. Only possible if the key has been in revoked status for a while.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"id": "33333333-3333-4333-8333-333333333333",
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a signing key, mainly its status — supabase.v1-update-project-signing-key
Update a signing key, mainly its status
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpdateSigningKeyBody" |
Full JSON Schema
Example input
{
"path": {
"id": "33333333-3333-4333-8333-333333333333",
"ref": "abcdefghijklmnopqrst"
},
"body": {
"status": "standby"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's auth config — supabase.v1-get-auth-service-config
Gets project's auth config
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates a project's auth config — supabase.v1-update-auth-service-config
Updates a project's auth config
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpdateAuthConfigBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"site_url": "https://app.example.com",
"disable_signup": false,
"jwt_exp": 3600
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Creates a new third-party auth integration — supabase.v1-create-project-tpa-integration
Creates a new third-party auth integration
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/CreateThirdPartyAuthBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"oidc_issuer_url": "https://login.acme.com",
"jwks_url": "https://login.acme.com/.well-known/jwks.json"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Lists all third-party auth integrations — supabase.v1-list-project-tpa-integrations
Lists all third-party auth integrations
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Removes a third-party auth integration — supabase.v1-delete-project-tpa-integration
Removes a third-party auth integration
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.tpa_id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"tpa_id": "88888888-8888-4888-8888-888888888888"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a third-party integration — supabase.v1-get-project-tpa-integration
Get a third-party integration
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.tpa_id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"tpa_id": "88888888-8888-4888-8888-888888888888"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Pauses the given project — supabase.v1-pause-a-project
Pauses the given project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Restarts the given project — supabase.v1-restart-a-project
Restarts the given project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Lists available restore versions for the given project — supabase.v1-list-available-restore-versions
Lists available restore versions for the given project
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Restores the given project — supabase.v1-restore-a-project
Restores the given project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancels the given project restoration — supabase.v1-cancel-a-project-restoration
Cancels the given project restoration
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List billing addons and compute instance selections — supabase.v1-list-project-addons
Returns the billing addons that are currently applied, including the active compute instance size, and lists every addon option that can be provisioned with pricing metadata.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Apply or update billing addons, including compute instance size — supabase.v1-apply-project-addon
Selects an addon variant, for example scaling the project’s compute instance up or down, and applies it to the project.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/ApplyProjectAddonBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"addon_variant": "pitr_7",
"addon_type": "pitr"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove billing addons or revert compute instance sizing — supabase.v1-remove-project-addon
Disables the selected addon variant, including rolling the compute instance back to its previous size.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.addon_variant |
— | Required | ||
path.addon_variant |
string | Required | anyOf[1]; enum: ["ci_micro","ci_small","ci_medium","ci_large","ci_xlarge","ci_2xlarge","ci_4xlarge","ci_8xlarge","ci_12xlarge","ci_16xlarge","ci_24xlarge","ci_24xlarge_optimized_cpu","ci_24xlarge_optimized_memory","ci_24xlarge_high_memory","ci_48xlarge","ci_48xlarge_optimized_cpu","ci_48xlarge_optimized_memory","ci_48xlarge_high_memory"] |
|
path.addon_variant |
string | Required | anyOf[2]; enum: ["cd_default"] |
|
path.addon_variant |
string | Required | anyOf[3]; enum: ["pitr_7","pitr_14","pitr_28"] |
|
path.addon_variant |
string | Required | anyOf[4]; enum: ["ipv4_default"] |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"addon_variant": "pitr_7"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project claim token — supabase.v1-get-project-claim-token
Gets project claim token
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Creates project claim token — supabase.v1-create-project-claim-token
Creates project claim token
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Revokes project claim token — supabase.v1-delete-project-claim-token
Revokes project claim token
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project performance advisors. — supabase.v1-get-performance-advisors
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project security advisors. — supabase.v1-get-security-advisors
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.lint_type |
string | Optional | enum: ["sql"] |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets all project's logs in a single log stream — supabase.v1-get-project-logs
Executes an SQL or LQL query on the project's unified logs stream.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.sql |
string | Optional | Custom SQL query to execute on the logs. See querying logs for more details. | |
query.iso_timestamp_start |
string | Optional | pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"; format: "date-time" |
|
query.iso_timestamp_end |
string | Optional | pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"; format: "date-time" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's usage api counts — supabase.v1-get-project-usage-api-count
Gets project's usage api counts
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.interval |
string | Optional | enum: ["15min","30min","1hr","3hr","1day","3day","7day"] |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's usage api requests count — supabase.v1-get-project-usage-request-count
Gets project's usage api requests count
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets a project's function combined statistics — supabase.v1-get-project-function-combined-stats
Gets a project's function combined statistics
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Required | additionalProperties: false |
|
query.interval |
string | Required | enum: ["15min","1hr","3hr","1day"] |
|
query.function_id |
string | Required |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"query": {
"interval": "1hr",
"function_id": "3c078cce-ad70-4148-9f37-4da362789053"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Scrape a project's metrics — supabase.v1-scrape-project-metrics
Prometheus scrape endpoint. Returns metrics of a customer project in the Prometheus open exposition format.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a login role for CLI with temporary password — supabase.v1-create-login-role
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/CreateRoleBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"read_only": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete existing login roles used by CLI — supabase.v1-delete-login-roles
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List applied migration versions — supabase.v1-list-migration-history
List applied migration versions
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Apply a database migration — supabase.v1-apply-a-migration
Apply a database migration
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
headers |
object | Optional | additionalProperties: false |
|
headers.Idempotency-Key |
string | Optional | A unique key to ensure the same migration is tracked only once. | |
body |
— | Required | $ref: "#/definitions/V1CreateMigrationBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"query": "create table public.widgets(id bigint primary key);",
"name": "create_widgets_table",
"rollback": "drop table if exists public.widgets;"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Upsert a database migration without applying — supabase.v1-upsert-a-migration
Upsert a database migration without applying
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
headers |
object | Optional | additionalProperties: false |
|
headers.Idempotency-Key |
string | Optional | A unique key to ensure the same migration is tracked only once. | |
body |
— | Required | $ref: "#/definitions/V1UpsertMigrationBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"query": "create table public.widgets(id bigint primary key);",
"name": "create_widgets_table",
"rollback": "drop table if exists public.widgets;"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Rollback database migrations and remove them from history table — supabase.v1-rollback-migrations
Rollback database migrations and remove them from history table
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Required | additionalProperties: false |
|
query.gte |
string | Required | Rollback migrations greater or equal to this version | pattern: "^\\d+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"query": {
"gte": "20250312000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Fetch an existing entry from migration history — supabase.v1-get-a-migration
Fetch an existing entry from migration history
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.version |
string | Required | pattern: "^\\d+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"version": "20250312000000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Patch an existing entry in migration history — supabase.v1-patch-a-migration
Patch an existing entry in migration history
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.version |
string | Required | pattern: "^\\d+$" |
|
body |
— | Required | $ref: "#/definitions/V1PatchMigrationBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"version": "20250312000000"
},
"body": {
"name": "create_widgets_table",
"rollback": "drop table if exists public.widgets;"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Run sql query — supabase.v1-run-a-query
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1RunQueryBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"query": "select * from pg_stat_activity limit 1;",
"read_only": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Run a sql query as supabase_read_only_user — supabase.v1-read-only-query
All entity references must be schema qualified.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1ReadOnlyQueryBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"query": "select * from pg_stat_activity limit 1;"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Enables Database Webhooks on the project — supabase.v1-enable-database-webhook
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets database metadata for the given project. — supabase.v1-get-database-metadata
This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates the database password — supabase.v1-update-database-password
Updates the database password
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1UpdatePasswordBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"password": "correct-horse-battery-staple"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get user-id to role mappings for JIT access — supabase.v1-get-jit-access
Mappings of roles a user can assume in the project database
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates a user mapping for JIT access — supabase.v1-update-jit-access
Modifies the roles that can be assumed and for how long
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpdateJitAccessBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"user_id": "55555555-5555-4555-8555-555555555555",
"roles": [
{
"role": "postgres",
"expires_at": 1740787200,
"allowed_networks": {
"allowed_cidrs": [
{
"cidr": "203.0.113.0/24"
}
]
},
"branches_only": false
}
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all user-id to role mappings for JIT access — supabase.v1-list-jit-access
Mappings of roles a user can assume in the project database
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Invites an external user to a database for JIT access — supabase.v1-invite-external-jit-access
Invites the external user and sets initial roles that can be assumed and for how long
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/InviteExternalUserJitAccessBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"email": "[email protected]",
"roles": [
{
"role": "postgres",
"expires_at": 1740787200,
"allowed_networks": {
"allowed_cidrs": [
{
"cidr": "203.0.113.0/24"
}
]
},
"branches_only": false
}
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Deletes the invite for an external user to a database for JIT access — supabase.v1-delete-invite-external-jit-access
Revokes and deletes the invitation
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.invite_id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"invite_id": "55555555-5555-4555-8555-555555555555"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete JIT access by user-id — supabase.v1-delete-jit-access
Remove JIT mappings of a user, revoking all JIT database access
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.user_id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"user_id": "55555555-5555-4555-8555-555555555555"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get PostgREST OpenAPI spec — supabase.v1-get-database-openapi
Returns the PostgREST OpenAPI specification for the project. This is the replacement for querying /rest/v1/ directly with the anon key.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.schema |
string | Optional | The database schema to generate the OpenAPI spec for | default: "public" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all functions — supabase.v1-list-all-functions
Returns all functions you've previously added to the specified project.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk update functions — supabase.v1-bulk-update-functions
Bulk update functions. It will create a new function or replace existing. The operation is idempotent. NOTE: You will need to manually bump the version.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/BulkUpdateFunctionBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": [
{
"id": "3c078cce-ad70-4148-9f37-4da362789053",
"slug": "hello-world",
"name": "Hello World",
"status": "ACTIVE",
"version": 2,
"verify_jwt": true,
"entrypoint_path": "index.ts"
}
]
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a function — supabase.v1-get-a-function
Retrieves a function with the specified slug and project.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.function_slug |
string | Required | Function slug | pattern: "^[A-Za-z0-9_-]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"function_slug": "hello-world"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a function — supabase.v1-update-a-function
Updates a function with the specified slug and project.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.function_slug |
string | Required | Function slug | pattern: "^[A-Za-z0-9_-]+$" |
query |
object | Optional | additionalProperties: false |
|
query.slug |
string | Optional | pattern: "^[A-Za-z0-9_-]+$" |
|
query.name |
string | Optional | ||
query.verify_jwt |
string | Optional | ||
query.import_map |
string | Optional | ||
query.entrypoint_path |
string | Optional | ||
query.import_map_path |
string | Optional | ||
query.ezbr_sha256 |
string | Optional | ||
body |
— | Required | $ref: "#/definitions/V1UpdateFunctionBodyJson" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"function_slug": "hello-world"
},
"body": {
"name": "Hello World",
"body": "Deno.serve(() => new Response('Hello again!'))",
"verify_jwt": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a function — supabase.v1-delete-a-function
Deletes a function with the specified slug from the specified project.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.function_slug |
string | Required | Function slug | pattern: "^[A-Za-z0-9_-]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"function_slug": "hello-world"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a function body — supabase.v1-get-a-function-body
Retrieves a function body for the specified slug and project.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.function_slug |
string | Required | Function slug | pattern: "^[A-Za-z0-9_-]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"function_slug": "hello-world"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Lists all buckets — supabase.v1-list-all-buckets
Lists all buckets
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get database disk attributes — supabase.v1-get-database-disk
Get database disk attributes
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Modify database disk — supabase.v1-modify-database-disk
Modify database disk
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/DiskRequestBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"attributes": {
"type": "gp3",
"size_gb": 100,
"iops": 3000,
"throughput_mibps": 125
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get disk utilization — supabase.v1-get-disk-utilization
Get disk utilization
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project disk autoscale config — supabase.v1-get-project-disk-autoscale-config
Gets project disk autoscale config
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's storage config — supabase.v1-get-storage-config
Gets project's storage config
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates project's storage config — supabase.v1-update-storage-config
Updates project's storage config
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpdateStorageConfigBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"fileSizeLimit": 10485760,
"features": {
"imageTransformation": {
"enabled": true
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get project's pgbouncer config — supabase.v1-get-project-pgbouncer-config
Get project's pgbouncer config
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's supavisor config — supabase.v1-get-pooler-config
Gets project's supavisor config
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates project's supavisor config — supabase.v1-update-pooler-config
Updates project's supavisor config
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpdateSupavisorConfigBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"default_pool_size": 25,
"pool_mode": "transaction"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project's Postgres config — supabase.v1-get-postgres-config
Gets project's Postgres config
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates project's Postgres config — supabase.v1-update-postgres-config
Updates project's Postgres config
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpdatePostgresConfigBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"max_connections": 120,
"shared_buffers": "256MB",
"work_mem": "4MB",
"statement_timeout": "60000ms"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets realtime configuration — supabase.v1-get-realtime-config
Gets realtime configuration
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates realtime configuration — supabase.v1-update-realtime-config
Updates realtime configuration
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/UpdateRealtimeConfigBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"private_only": false,
"max_concurrent_users": 1000,
"max_channels_per_client": 100
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Shutdowns realtime connections for a project — supabase.v1-shutdown-realtime
Shutdowns realtime connections for a project
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Creates a new SSO provider — supabase.v1-create-a-sso-provider
Creates a new SSO provider
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/CreateProviderBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"type": "saml",
"metadata_url": "https://sso.acme.com/metadata.xml",
"domains": [
"acme.com"
],
"attribute_mapping": {
"keys": {
"email": {
"name": "email"
},
"first_name": {
"name": "first_name"
},
"last_name": {
"name": "last_name"
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Lists all SSO providers — supabase.v1-list-all-sso-provider
Lists all SSO providers
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets a SSO provider by its UUID — supabase.v1-get-a-sso-provider
Gets a SSO provider by its UUID
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.provider_id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"provider_id": "77777777-7777-4777-8777-777777777777"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates a SSO provider by its UUID — supabase.v1-update-a-sso-provider
Updates a SSO provider by its UUID
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.provider_id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
|
body |
— | Required | $ref: "#/definitions/UpdateProviderBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"provider_id": "77777777-7777-4777-8777-777777777777"
},
"body": {
"metadata_url": "https://sso.acme.com/metadata.xml",
"domains": [
"acme.com",
"contractors.acme.com"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Removes a SSO provider by its UUID — supabase.v1-delete-a-sso-provider
Removes a SSO provider by its UUID
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
path.provider_id |
string | Required | pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst",
"provider_id": "77777777-7777-4777-8777-777777777777"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Lists all backups — supabase.v1-list-all-backups
Lists all backups
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Restores a PITR backup for a database — supabase.v1-restore-pitr-backup
Restores a PITR backup for a database
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1RestorePitrBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"recovery_time_target_unix": 1740787200
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiates a creation of a restore point for a database — supabase.v1-create-restore-point
Initiates a creation of a restore point for a database
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1RestorePointPostBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"name": "before-upgrade"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get restore points for project — supabase.v1-get-restore-point
Get restore points for project
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
query |
object | Optional | additionalProperties: false |
|
query.name |
string | Optional | maxLength: 20 |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Restores a physical backup for a database — supabase.v1-restore-physical-backup
Restores a physical backup for a database
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1RestoreBackupBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"id": 12345
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets the backup schedule for a project — supabase.v1-get-backup-schedule
Gets the backup schedule for a project
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Updates the backup schedule time for a project — supabase.v1-update-backup-schedule
Sets the time at which the daily backup runs. The change takes effect on the next backup window that includes the new time. If the new time has already passed for today, the first backup at the new time will occur the following day. It can only be updated 3 times per 24 hours.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1UpdateBackupScheduleBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"schedule_for": "04:00:00"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiates an undo to a given restore point — supabase.v1-undo
Initiates an undo to a given restore point
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ref |
string | Required | Project ref | minLength: 20; maxLength: 20; pattern: "^[a-z]+$" |
body |
— | Required | $ref: "#/definitions/V1UndoBody" |
Full JSON Schema
Example input
{
"path": {
"ref": "abcdefghijklmnopqrst"
},
"body": {
"name": "before-upgrade"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get entitlements for an organization — supabase.v1-get-organization-entitlements
Returns the entitlements available to the organization based on their plan and any overrides.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.slug |
string | Required | Organization slug | pattern: "^[\\w-]+$" |
Full JSON Schema
Example input
{
"path": {
"slug": "tsrqponmlkjihgfedcba"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List members of an organization — supabase.v1-list-organization-members
List members of an organization
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.slug |
string | Required | Organization slug | pattern: "^[\\w-]+$" |
Full JSON Schema
Example input
{
"path": {
"slug": "tsrqponmlkjihgfedcba"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets information about the organization — supabase.v1-get-an-organization
Gets information about the organization
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.slug |
string | Required | Organization slug | pattern: "^[\\w-]+$" |
Full JSON Schema
Example input
{
"path": {
"slug": "tsrqponmlkjihgfedcba"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets project details for the specified organization and claim token — supabase.v1-get-organization-project-claim
Gets project details for the specified organization and claim token
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.slug |
string | Required | Organization slug | pattern: "^[\\w-]+$" |
path.token |
string | Required |
Full JSON Schema
Example input
{
"path": {
"slug": "tsrqponmlkjihgfedcba",
"token": "0123456789abcdef0123456789abcdef01234567"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Claims project for the specified organization — supabase.v1-claim-project-for-organization
Claims project for the specified organization
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.slug |
string | Required | Organization slug | pattern: "^[\\w-]+$" |
path.token |
string | Required |
Full JSON Schema
Example input
{
"path": {
"slug": "tsrqponmlkjihgfedcba",
"token": "0123456789abcdef0123456789abcdef01234567"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Gets all projects for the given organization — supabase.v1-get-all-projects-for-organization
Returns a paginated list of projects for the specified organization.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.slug |
string | Required | Organization slug | pattern: "^[\\w-]+$" |
query |
object | Optional | additionalProperties: false |
|
query.offset |
integer | Optional | Number of projects to skip | default: 0; minimum: 0; maximum: 9007199254740991 |
query.limit |
integer | Optional | Number of projects to return per page | default: 100; minimum: 1; maximum: 100 |
query.search |
string | Optional | Search projects by name | |
query.sort |
string | Optional | Sort order for projects | enum: ["name_asc","name_desc","created_asc","created_desc"]; default: "name_asc" |
query.statuses |
string | Optional | A comma-separated list of project statuses to filter by. The following values are supported: ACTIVE_HEALTHY, INACTIVE. |
Full JSON Schema
Example input
{
"path": {
"slug": "tsrqponmlkjihgfedcba"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Errors
Check the key's expiry, revocation, workspace and allowed operations.
Reuse the same idempotency key only for the same request.
The connection or provider limit has been reached. Check the receipt before retrying.
Test the connection
Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.