Supabase | Composio Docs

Overview

SLUG

SUPABASE

Description

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

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

stringDefaults to all

bearer_token

string

API Key

bearer_token

stringRequired

Tools

Create an organization

SLUG: SUPABASE_CREATE_AN_ORGANIZATION

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

Action Parameters

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create new project

SLUG: SUPABASE_CREATE_A_PROJECT

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

Action Parameters

db_pass

stringRequired

desired_instance_size

string

kps_enabled

boolean

name

stringRequired

organization_id

stringRequired

plan

string

postgres_engine

string

region

stringRequired

release_channel

string

template_url

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

List all organizations

SLUG: SUPABASE_LIST_ALL_ORGANIZATIONS

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

Action Parameters

Action Response

data

arrayRequired

error

string

successful

booleanRequired

List all projects

SLUG: SUPABASE_LIST_ALL_PROJECTS

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

Action Parameters

Action Response

data

arrayRequired

error

string

successful

booleanRequired

Create project api key

SLUG: SUPABASE_ALPHA_CREATES_A_NEW_API_KEY_FOR_THE_PROJECT

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

Action Parameters

description

string

ref

stringRequired

type

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete an API key from the project

SLUG: SUPABASE_ALPHA_DELETES_AN_API_KEY_FOR_THE_PROJECT

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

Action Parameters

stringRequired

ref

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get a third-party integration

SLUG: SUPABASE_ALPHA_GET_A_THIRD_PARTY_INTEGRATION

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

Action Parameters

ref

stringRequired

tpa_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

List third-party auth integrations for project

SLUG: SUPABASE_ALPHA_LISTS_ALL_THIRD_PARTY_AUTH_INTEGRATIONS

Lists all configured third-party authentication provider integrations for an existing supabase project (using its `ref`), suitable for read-only auditing or verifying current authentication settings.

Action Parameters

ref

stringRequired

Action Response

data

arrayRequired

error

string

successful

booleanRequired

Delete third party auth config

SLUG: SUPABASE_ALPHA_REMOVES_A_THIRD_PARTY_AUTH_INTEGRATION

Removes a third-party authentication provider (e.g., google, github) from a supabase project's configuration; this immediately prevents users from logging in via that method.

Action Parameters

ref

stringRequired

tpa_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update an API key for the project

SLUG: SUPABASE_ALPHA_UPDATES_AN_API_KEY_FOR_THE_PROJECT

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

Action Parameters

description

string

stringRequired

ref

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Beta activate custom hostname for project

SLUG: SUPABASE_BETA_ACTIVATES_A_CUSTOM_HOSTNAME_FOR_A_PROJECT

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

Action Parameters

ref

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Activate vanity subdomain for project

SLUG: SUPABASE_BETA_ACTIVATES_A_VANITY_SUBDOMAIN_FOR_A_PROJECT

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

Action Parameters

ref

stringRequired

vanity_subdomain

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Authorize user through OAuth

SLUG: SUPABASE_BETA_AUTHORIZE_USER_THROUGH_OAUTH

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

Action Parameters

client_id

stringRequired

code_challenge

string

code_challenge_method

string

redirect_uri

stringRequired

response_mode

string

response_type

stringRequired

scope

string

state

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Check vanity subdomain availability

SLUG: SUPABASE_BETA_CHECKS_VANITY_SUBDOMAIN_AVAILABILITY

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

Action Parameters

ref

stringRequired

vanity_subdomain

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Enable project database webhooks

SLUG: SUPABASE_BETA_ENABLES_DATABASE_WEBHOOKS_ON_THE_PROJECT

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

Action Parameters

ref

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get current vanity subdomain config

SLUG: SUPABASE_BETA_GETS_CURRENT_VANITY_SUBDOMAIN_CONFIG

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

Action Parameters

ref

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Beta get project's custom hostname config

SLUG: SUPABASE_BETA_GETS_PROJECT_S_CUSTOM_HOSTNAME_CONFIG

Retrieves a supabase project's custom hostname configuration, including its status, ssl certificate, and ownership verification, noting that availability may depend on the project's plan.

Action Parameters

ref

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Retrieve network bans for project

SLUG: SUPABASE_BETA_GETS_PROJECT_S_NETWORK_BANS

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

Action Parameters

ref

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Retrieve project network restrictions

SLUG: SUPABASE_BETA_GETS_PROJECT_S_NETWORK_RESTRICTIONS

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

Action Parameters

ref

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get project pgsodium config

SLUG: SUPABASE_BETA_GETS_PROJECT_S_PGSODIUM_CONFIG

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

Action Parameters

ref

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired