> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Supabase

> How to set up the Supabase connector, plus the actions and events that are available.

![Supabase](https://stackone-logos.com/api/supabase/filled/svg)

v2.1.3[See changelog](https://docs.stackone.com/connectors/supabase/changelog.md)

[138 actions](#actions) · [9 events](#events) · 2 auth methods

Databases
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Personal Access Token (PAT) · Connector Profile](https://docs.stackone.com/connectors/supabase/guides/connector-profile/personal-access-token-pat.md)
>
> No app registration required. The token acts with the access of the Supabase user who creates it, limited to the organiz...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/supabase/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth app. Supports fine-grained scopes across database, storage, and project management.

Optionally, configure receiving Events for Supabase into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/supabase/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Personal Access Token (PAT) · Link Account](https://docs.stackone.com/connectors/supabase/guides/link-account/personal-access-token-pat.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/supabase/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0

Personal Access Token (PAT)

No auth methods found

Scopes

Select all
|
Clear

analytics:read

auth:read

auth:write

database:read

database:write

domains:read

domains:write

edge\_functions:read

edge\_functions:write

environment:read

environment:write

organizations:read

projects:read

projects:write

rest:read

rest:write

secrets:read

secrets:write

storage:read

No scopes found

138 actions

ActionDescriptionRequired scopes

Get Readonly Mode Status`supabase_get_readonly_mode_status`

Check if database is in readonly mode

`database:read`

Disable Readonly Mode Temporarily`supabase_disable_readonly_mode_temporarily`

Temporarily disable readonly mode for maintenance

`database:write`

Get Project PgBouncer Config`supabase_get_project_pgbouncer_config`

Retrieve PgBouncer connection pooler configuration

`database:read`

Enable Database Webhook`supabase_enable_database_webhook`

Enable webhooks for database events

`database:write`

List All Snippets`supabase_list_all_snippets`

Retrieve all SQL code snippets for the logged in user

`database:read`

Get Snippet`supabase_get_snippet`

Retrieve a specific SQL code snippet

`database:read`

Get Function Combined Statistics`supabase_get_function_combined_statistics`

Get combined statistics for a project's functions

Get Project Logs`supabase_get_project_logs`

Execute SQL query on project logs

`analytics:read`

Get Usage API Counts`supabase_get_usage_api_counts`

Get project's usage API counts

Get Usage API Requests Count`supabase_get_usage_api_requests_count`

Get project's usage API requests count

Create SSO Provider`supabase_create_sso_provider`

Create a new SSO provider for the project

`auth:write`

Get SSO Provider`supabase_get_sso_provider`

Get details of a specific SSO provider

`auth:read`

Update SSO Provider`supabase_update_sso_provider`

Update an existing SSO provider configuration

`auth:write`

Delete SSO Provider`supabase_delete_sso_provider`

Delete an SSO provider from the project

`auth:write`

List All SSO Providers`supabase_list_sso_providers`

List all SSO providers for the project

`auth:read`

Create Legacy Signing Key`supabase_create_legacy_signing_key`

Set up the project's existing JWT secret as an in-use JWT signing key

`secrets:write`

Get Legacy Signing Key`supabase_get_legacy_signing_key`

Get the signing key information for the JWT secret imported as signing key

`secrets:read`

Create Project Signing Key`supabase_create_project_signing_key`

Create a new signing key for the project in standby status

`secrets:write`

Get Project Signing Key`supabase_get_project_signing_key`

Get information about a signing key

Get Project Signing Keys`supabase_list_project_signing_keys`

List all signing keys for the project

`secrets:read`

Update Project Signing Key`supabase_update_project_signing_key`

Update a signing key, mainly its status

`secrets:write`

Remove Project Signing Key`supabase_remove_project_signing_key`

Remove a signing key from a project

`secrets:write`

Create Project TPA Integration`supabase_create_tpa_integration`

Creates a new third-party auth integration

`auth:write`

Get Project TPA Integration`supabase_get_tpa_integration`

Get a third-party integration

`auth:read`

Delete Project TPA Integration`supabase_delete_tpa_integration`

Removes a third-party auth integration

`auth:write`

List Project TPA Integrations`supabase_list_tpa_integrations`

Lists all third-party auth integrations

`auth:read`

Get Auth Service Config`supabase_get_auth_config`

Gets project's auth config

`auth:read`

Update Auth Service Config`supabase_update_auth_config`

Updates a project's auth config

`auth:write`

List All Backups`supabase_list_all_backups`

Retrieve a list of all available database backups

`database:read`

Restore PITR Backup`supabase_restore_pitr_backup`

Restore database from a Point-in-Time Recovery backup

`database:write`

Get Database Config`supabase_get_database_config`

Retrieve PostgreSQL database configuration for the project

`database:read`

Update Database Config`supabase_update_database_config`

Update PostgreSQL database configuration settings

`database:write`

Get Database Metadata`supabase_get_database_metadata`

Retrieve database connection strings and metadata

`projects:read`

Update Database Password`supabase_update_database_password`

Update the database password for the project

`database:write`

Run Query`supabase_run_query`

Execute a SQL query on the database

`database:write`

Read-Only Query`supabase_read_only_query`

Execute a read-only SQL query on the database

`database:read`

Generate TypeScript Types`supabase_generate_typescript_types`

Generate TypeScript type definitions from database schema

`database:read`

Get Pooler Config`supabase_get_pooler_config`

Retrieve connection pooler configuration

`database:read`

Update Pooler Config`supabase_update_pooler_config`

Update connection pooler configuration

`database:write`

Get SSL Enforcement Config`supabase_get_ssl_enforcement_config`

Retrieve SSL enforcement configuration

`database:read`

Update SSL Enforcement Config`supabase_update_ssl_enforcement_config`

Update SSL enforcement configuration

`database:write`

Check Vanity Subdomain Availability`supabase_check_vanity_subdomain_availability`

Check if a vanity subdomain is available

`domains:write`

Activate Vanity Subdomain`supabase_activate_vanity_subdomain`

Activate a vanity subdomain for the project

`domains:write`

Get Vanity Subdomain Config`supabase_get_vanity_subdomain_config`

Get the vanity subdomain configuration

`domains:read`

Deactivate Vanity Subdomain`supabase_deactivate_vanity_subdomain`

Deactivate and remove the vanity subdomain

`domains:write`

Initialize Custom Hostname`supabase_initialize_custom_hostname`

Initialize a custom hostname for the project

`domains:write`

Activate Custom Hostname`supabase_activate_custom_hostname`

Activate the custom hostname after DNS verification

`domains:write`

Get Hostname Config`supabase_get_hostname_config`

Get the custom hostname configuration

`domains:read`

Reverify DNS Config`supabase_reverify_dns_config`

Reverify DNS configuration for custom hostname

`domains:write`

Update Custom Hostname`supabase_update_custom_hostname`

Update the custom hostname configuration

`domains:write`

List All Branches`supabase_list_all_branches`

List all branches

`environment:read`

Get A Branch`supabase_get_a_branch`

Get a database branch by name

`environment:read`

Create A Branch`supabase_create_a_branch`

Create a database branch

`environment:write`

Delete A Branch`supabase_delete_a_branch`

Delete a database branch

`environment:write`

Merge A Branch`supabase_merge_a_branch`

Merge a database branch

`environment:write`

Push A Branch`supabase_push_a_branch`

Push a database branch

`environment:write`

Reset A Branch`supabase_reset_a_branch`

Reset a database branch

`environment:write`

Restore A Scheduled Branch Deletion`supabase_restore_a_branch`

Restore a scheduled branch deletion

`environment:write`

Diff A Branch`supabase_diff_a_branch`

Diff a database branch

`environment:write`

Disable Preview Branching`supabase_disable_preview_branching`

Disables preview branching

`environment:write`

Get Database Branch Config`supabase_get_a_branch_config`

Get database branch config

`environment:read`

Update Database Branch Config`supabase_update_a_branch_config`

Update database branch config

`environment:write`

List All Action Runs`supabase_list_action_runs`

List all action runs

`environment:read`

Count The Number Of Action Runs`supabase_count_action_runs`

Count the number of action runs

`environment:read`

Get The Status Of An Action Run`supabase_get_action_run`

Get the status of an action run

`environment:read`

Get The Logs Of An Action Run`supabase_get_action_run_logs`

Get the logs of an action run

`environment:read`

Update The Status Of An Action Run`supabase_update_action_run_status`

Update the status of an action run

`environment:write`

List All Functions`supabase_list_all_functions`

Retrieve a list of all Edge Functions in a project

`edge_functions:read`

Get A Function`supabase_get_function`

Retrieve details of a specific Edge Function

`edge_functions:read`

Get A Function Body`supabase_get_function_body`

Retrieve the source code body of an Edge Function

`edge_functions:read`

Create A Function`supabase_create_function`

Create a new Edge Function in a project

`edge_functions:write`

Update A Function`supabase_update_function`

Update an existing Edge Function configuration or code

`edge_functions:write`

Bulk Update Functions`supabase_bulk_update_functions`

Update multiple Edge Functions at once

`edge_functions:write`

Deploy A Function`supabase_deploy_function`

Deploy a new function bundle with code

`edge_functions:write`

Delete A Function`supabase_delete_function`

Delete an Edge Function from a project

`edge_functions:write`

Get Unified Credentials`supabase_unified_get_me`

Get the current Supabase connection's unified credentials and identity.

List Unified Organizations`supabase_unified_list_organizations`

List unified organizations in Supabase.

`organizations:read`

Get Unified Organization`supabase_unified_get_organization`

Get a unified Supabase organization by ID.

`organizations:read`

List Unified Resource Types`supabase_unified_list_resource_types`

List unified resource types in Supabase.

List Unified Resource Users`supabase_unified_list_resource_users`

List unified resource users in Supabase.

`organizations:read`

List Unified Roles`supabase_unified_list_roles`

List unified roles in Supabase.

`organizations:read`

Get Unified Role`supabase_unified_get_role`

Get a unified Supabase role by ID.

`organizations:read`

List Unified Users`supabase_unified_list_users`

List unified users in Supabase. filter.organization\_id is optional — auto-resolved when the connection sees exactly one...

`organizations:read`

Get Unified User`supabase_unified_get_user`

Get a unified Supabase user by ID. Resolves the connection's organization when exactly one is visible; returns 400 when...

`organizations:read`

List JIT Access`supabase_list_jit_access`

List all user-id to role mappings

Authorize JIT Access`supabase_authorize_jit_access`

Authorize user-id to role mappings (requires JIT enabled)

`database:read`

Get JIT Access`supabase_get_jit_access`

Get user-id to role mappings (requires JIT enabled)

`database:read`

Update JIT Access`supabase_update_jit_access`

Update a user mapping (requires JIT enabled)

Delete JIT Access`supabase_delete_jit_access`

Delete JIT access by user-id (requires JIT enabled)

Get JIT Access Config`supabase_get_jit_access_config`

Get project's just-in-time access configuration

`database:read`

Update JIT Access Config`supabase_update_jit_access_config`

Update project's just-in-time access configuration

`database:write`

List Migration History`supabase_list_migration_history`

List applied migration versions

`database:read`

Apply Database Migration`supabase_apply_database_migration`

Apply a database migration (partner OAuth apps only)

`database:write`

Get Migration Entry`supabase_get_migration_entry`

Fetch an existing entry from migration history (partner OAuth apps only)

`database:read`

Upsert Migration Without Applying`supabase_upsert_migration_without_applying`

Upsert a database migration without applying (partner OAuth apps only)

`database:write`

Patch Migration Entry`supabase_patch_migration_entry`

Patch an existing entry in migration history (partner OAuth apps only)

`database:write`

Rollback Database Migrations`supabase_rollback_database_migrations`

Rollback database migrations and remove them from history table (partner OAuth apps only)

`database:write`

List All Organizations`supabase_list_all_organizations`

Retrieve a list of all organizations the authenticated user has access to

`organizations:read`

Get Organization`supabase_get_organization`

Retrieve details for a specific organization

`organizations:read`

Create Organization`supabase_create_organization`

Create a new organization (Experimental)

List Organization Members`supabase_list_organization_members`

Retrieve a list of all members in an organization

`organizations:read`

Get PostgREST Configuration`supabase_get_postgrest_config`

Get the PostgREST API configuration for a project

`rest:read`

Update PostgREST Configuration`supabase_update_postgrest_config`

Updates project's PostgREST API config

`rest:write`

List All Projects`supabase_list_all_projects`

Retrieve a list of all projects in your organization

`projects:read`

Get All Projects For Organization`supabase_get_all_projects_for_organization`

Retrieve a list of all projects within a specific organization

`projects:read`

Get Project`supabase_get_project`

Retrieve details for a specific project

`projects:read`

Create Project`supabase_create_project`

Create a new Supabase project

`projects:write`

Update Project`supabase_update_project`

Update project settings and configuration

`projects:write`

Get Available Regions`supabase_get_available_regions`

Retrieve a list of all available regions for creating Supabase projects

`organizations:read`

Delete Project`supabase_delete_project`

Delete a Supabase project permanently

`projects:write`

Pause Project`supabase_pause_project`

Pause a Supabase project to reduce costs

`projects:write`

Restore Project`supabase_restore_project`

Restore a paused Supabase project

`projects:write`

Cancel Project Restoration`supabase_cancel_project_restoration`

Cancel an in-progress project restoration

`projects:write`

Get Services Health`supabase_get_services_health`

Get the health status of services for a project

`projects:read`

Get Network Restrictions`supabase_get_network_restrictions`

Get the network restrictions configuration for a project

`projects:read`

Update Network Restrictions`supabase_update_network_restrictions`

Update the network restrictions for a project

`projects:write`

Get Postgres Upgrade Eligibility`supabase_get_postgres_upgrade_eligibility`

Check if a project is eligible for a PostgreSQL version upgrade

`projects:read`

Upgrade Postgres Version`supabase_upgrade_postgres_version`

Upgrade the PostgreSQL version for a project

`projects:write`

Get Postgres Upgrade Status`supabase_get_postgres_upgrade_status`

Retrieve the status of an in-progress or completed Postgres version upgrade

`projects:read`

Get Realtime Configuration`supabase_get_realtime_config`

Get the realtime configuration for a project

Shutdown Realtime Connections`supabase_shutdown_realtime_connections`

Shutdown realtime connections for a project

Update Realtime Configuration`supabase_update_realtime_config`

Update the realtime configuration for a project

Remove Read Replica`supabase_remove_read_replica`

Remove a read replica

Create CLI Login Role`supabase_create_login_role`

Create a login role for CLI with temporary password

`database:write`

Delete CLI Login Roles`supabase_delete_login_roles`

Delete existing login roles used by CLI

`database:write`

List All Secrets`supabase_list_all_secrets`

Returns all secrets you've previously added to the specified project

`secrets:read`

Bulk Create Secrets`supabase_bulk_create_secrets`

Creates multiple secrets and adds them to the specified project

`secrets:write`

Bulk Delete Secrets`supabase_bulk_delete_secrets`

Deletes all secrets with the given names from the specified project

`secrets:write`

Get Project API Keys`supabase_get_project_api_keys`

Get project api keys

`secrets:read`

Get API Key`supabase_get_api_key`

Get API key

`secrets:read`

Create API Key`supabase_create_api_key`

Creates a new API key for the project

`secrets:write`

Delete API Key`supabase_delete_api_key`

Deletes an API key for the project

`secrets:write`

Update API Key`supabase_update_api_key`

Updates an API key for the project

`secrets:write`

Get PgSodium Config`supabase_get_pgsodium_config`

Get pgsodium config

`secrets:read`

Update PgSodium Config`supabase_update_pgsodium_config`

Update pgsodium config

`secrets:write`

Get Storage Config`supabase_get_storage_config`

Gets project's storage config

List All Buckets`supabase_list_all_buckets`

Lists all buckets

`storage:read`

Update Storage Config`supabase_update_storage_config`

Updates project's storage config

## Events

Tags

Select all
|
Clear

Buckets

Objects

Storage

Users

Webhooks

No tags found

9 events

EventDescriptionTags

Storage Object Created`supabase_webhook_storage_object_created`

Fired when a file (object) is uploaded to Supabase Storage.

StorageObjectsWebhooks

Storage Object Updated`supabase_webhook_storage_object_updated`

Fired when a file (object) in Supabase Storage is updated or overwritten.

StorageObjectsWebhooks

Storage Object Deleted`supabase_webhook_storage_object_deleted`

Fired when a file (object) is deleted from Supabase Storage.

StorageObjectsWebhooks

User Created`supabase_webhook_user_created`

Fired when a new user signs up or is created in Supabase Auth.

UsersWebhooks

User Updated`supabase_webhook_user_updated`

Fired when a user record changes in Supabase Auth (profile, confirmation, ban, metadata, or sign-in).

UsersWebhooks

User Deleted`supabase_webhook_user_deleted`

Fired when a user is permanently deleted from Supabase Auth.

UsersWebhooks

Bucket Created`supabase_webhook_bucket_created`

Fired when a storage bucket is created in Supabase Storage.

StorageBucketsWebhooks

Bucket Updated`supabase_webhook_bucket_updated`

Fired when a storage bucket's configuration changes in Supabase Storage.

StorageBucketsWebhooks

Bucket Deleted`supabase_webhook_bucket_deleted`

Fired when a storage bucket is deleted from Supabase Storage.

StorageBucketsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.