Open Connector
All tools

Supabase logoSupabase

Inspect Supabase organizations, projects, database configuration, service health, usage, and other Management API resources.

supabasevcatalog-v165 tools

Authentication

MethodKindStatusDetails
OAuth 2.0oauth2available
Management personal access token (manual)api_keyavailable

Call a tool

import { createClient } from "@open-connector/sdk";const oc = createClient({  baseUrl: "https://api.openconnector.dev",  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({  slug: "SUPABASE_V1_GENERATE_TYPESCRIPT_TYPES",  connectedAccountId: "conn_...",  arguments: { /* match this tool's input schema */ },});
import Composio from "@composio/client";const composio = new Composio({  baseURL: "https://api.openconnector.dev/composio",  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("SUPABASE_V1_GENERATE_TYPESCRIPT_TYPES", {  connected_account_id: "conn_...",  arguments: { /* match this tool's input schema */ },});
oc tools execute SUPABASE_V1_GENERATE_TYPESCRIPT_TYPES --data '{ }'

Tool catalog

Available tools

65 callable operations

Generate TypeScript typesSUPABASE_V1_GENERATE_TYPESCRIPT_TYPESReturns the TypeScript types of your schema for use with supabase-js.

Returns the TypeScript types of your schema for use with supabase-js.

Authentication

Connected account required

Scopes

database:read

Tags

Database
Get a database branchSUPABASE_V1_GET_A_BRANCHFetches the specified database branch by its name.

Fetches the specified database branch by its name.

Authentication

Connected account required

Scopes

environment:read

Tags

Environments
Get database branch configSUPABASE_V1_GET_A_BRANCH_CONFIGFetches configurations of the specified database branch

Fetches configurations of the specified database branch

Authentication

Connected account required

Scopes

environment:read

Tags

Environments
Retrieve a functionSUPABASE_V1_GET_A_FUNCTIONRetrieves a function with the specified slug and project.

Retrieves a function with the specified slug and project.

Authentication

Connected account required

Scopes

edge_functions:read

Tags

Edge Functions
Retrieve a function bodySUPABASE_V1_GET_A_FUNCTION_BODYRetrieves a function body for the specified slug and project.

Retrieves a function body for the specified slug and project.

Authentication

Connected account required

Scopes

edge_functions:read

Tags

Edge Functions
Fetch an existing entry from migration historySUPABASE_V1_GET_A_MIGRATIONFetch an existing entry from migration history

Fetch an existing entry from migration history

Authentication

Connected account required

Scopes

database:read

Tags

Database
Gets a specific SQL snippetSUPABASE_V1_GET_A_SNIPPETGets a specific SQL snippet

Gets a specific SQL snippet

Authentication

Connected account required

Scopes

database:read

Tags

Database
Gets a SSO provider by its UUIDSUPABASE_V1_GET_A_SSO_PROVIDERGets a SSO provider by its UUID

Gets a SSO provider by its UUID

Authentication

Connected account required

Scopes

auth:read

Tags

Auth
Get the status of an action runSUPABASE_V1_GET_ACTION_RUNReturns the current status of the specified action run.

Returns the current status of the specified action run.

Authentication

Connected account required

Scopes

environment:read

Tags

Environments
Get the logs of an action runSUPABASE_V1_GET_ACTION_RUN_LOGSReturns the logs from the specified action run.

Returns the logs from the specified action run.

Authentication

Connected account required

Scopes

environment:read

Tags

Environments
Gets all projects for the given organizationSUPABASE_V1_GET_ALL_PROJECTS_FOR_ORGANIZATIONReturns a paginated list of projects for the specified organization. This endpoint uses offset-based pagination. Use the `offset` parameter to skip a number of projects and the `limit` parameter to control the number of projects returned per page.

Returns a paginated list of projects for the specified organization. This endpoint uses offset-based pagination. Use the `offset` parameter to skip a number of projects and the `limit` parameter to control the number of projects returned per page.

Authentication

Connected account required

Scopes

projects:read

Tags

Projects
Gets information about the organizationSUPABASE_V1_GET_AN_ORGANIZATIONGets information about the organization

Gets information about the organization

Authentication

Connected account required

Scopes

organizations:read

Tags

Organizations
Gets project's auth configSUPABASE_V1_GET_AUTH_SERVICE_CONFIGGets project's auth config

Gets project's auth config

Authentication

Connected account required

Scopes

auth:read

Tags

Auth
[Beta] Gets the list of available regions that can be used for a new projectSUPABASE_V1_GET_AVAILABLE_REGIONS[Beta] Gets the list of available regions that can be used for a new project

[Beta] Gets the list of available regions that can be used for a new project

Authentication

Connected account required

Scopes

organizations:read

Tags

Projects
Gets the backup schedule for a projectSUPABASE_V1_GET_BACKUP_SCHEDULEGets the backup schedule for a project

Gets the backup schedule for a project

Authentication

Connected account required

Scopes

database:read

Tags

Database
Get database disk attributesSUPABASE_V1_GET_DATABASE_DISKGet database disk attributes

Get database disk attributes

Authentication

Connected account required

Tags

Projects
Gets database metadata for the given project.SUPABASE_V1_GET_DATABASE_METADATAThis 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 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.

Authentication

Connected account required

Scopes

projects:read

Tags

Database
Get PostgREST OpenAPI specSUPABASE_V1_GET_DATABASE_OPENAPIReturns the PostgREST OpenAPI specification for the project. This is the replacement for querying `/rest/v1/` directly with the anon key.

Returns the PostgREST OpenAPI specification for the project. This is the replacement for querying `/rest/v1/` directly with the anon key.

Authentication

Connected account required

Scopes

database:read

Tags

Database
Get disk utilizationSUPABASE_V1_GET_DISK_UTILIZATIONGet disk utilization

Get disk utilization

Authentication

Connected account required

Tags

Projects
[Beta] Gets project's custom hostname configSUPABASE_V1_GET_HOSTNAME_CONFIG[Beta] Gets project's custom hostname config

[Beta] Gets project's custom hostname config

Authentication

Connected account required

Scopes

domains:read

Tags

Domains
Get user-id to role mappings for JIT accessSUPABASE_V1_GET_JIT_ACCESSMappings of roles a user can assume in the project database

Mappings of roles a user can assume in the project database

Authentication

Connected account required

Scopes

database:read

Tags

Database
[Beta] Get project's temporary access configuration.SUPABASE_V1_GET_JIT_ACCESS_CONFIG[Beta] Get project's temporary access configuration.

[Beta] Get project's temporary access configuration.

Authentication

Connected account required

Scopes

database:read

Tags

Database
[Beta] Gets project's network restrictionsSUPABASE_V1_GET_NETWORK_RESTRICTIONS[Beta] Gets project's network restrictions

[Beta] Gets project's network restrictions

Authentication

Connected account required

Scopes

projects:read

Tags

Projects
Get entitlements for an organizationSUPABASE_V1_GET_ORGANIZATION_ENTITLEMENTSReturns the entitlements available to the organization based on their plan and any overrides.

Returns the entitlements available to the organization based on their plan and any overrides.

Authentication

Connected account required

Scopes

organizations:read

Tags

Organizations
Gets project details for the specified organization and claim tokenSUPABASE_V1_GET_ORGANIZATION_PROJECT_CLAIMGets project details for the specified organization and claim token

Gets project details for the specified organization and claim token

Authentication

Connected account required

Tags

Organizations
Gets project performance advisors.SUPABASE_V1_GET_PERFORMANCE_ADVISORSThis 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 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.

Authentication

Connected account required

Scopes

database:read

Tags

Advisors
Gets project's supavisor configSUPABASE_V1_GET_POOLER_CONFIGGets project's supavisor config

Gets project's supavisor config

Authentication

Connected account required

Scopes

database:read

Tags

Database
Gets project's Postgres configSUPABASE_V1_GET_POSTGRES_CONFIGGets project's Postgres config

Gets project's Postgres config

Authentication

Connected account required

Scopes

database:read

Tags

Database
[Beta] Returns the project's eligibility for upgradesSUPABASE_V1_GET_POSTGRES_UPGRADE_ELIGIBILITY[Beta] Returns the project's eligibility for upgrades

[Beta] Returns the project's eligibility for upgrades

Authentication

Connected account required

Scopes

projects:read

Tags

Projects
[Beta] Gets the latest status of the project's upgradeSUPABASE_V1_GET_POSTGRES_UPGRADE_STATUS[Beta] Gets the latest status of the project's upgrade

[Beta] Gets the latest status of the project's upgrade

Authentication

Connected account required

Scopes

projects:read

Tags

Projects
Gets project's postgrest configSUPABASE_V1_GET_POSTGREST_SERVICE_CONFIGGets project's postgrest config

Gets project's postgrest config

Authentication

Connected account required

Scopes

rest:read

Tags

Rest
Gets the user's profileSUPABASE_V1_GET_PROFILEGets the user's profile

Gets the user's profile

Authentication

Connected account required

Tags

Profile
Gets a specific project that belongs to the authenticated userSUPABASE_V1_GET_PROJECTGets a specific project that belongs to the authenticated user

Gets a specific project that belongs to the authenticated user

Authentication

Connected account required

Scopes

projects:read

Tags

Projects
Gets project disk autoscale configSUPABASE_V1_GET_PROJECT_DISK_AUTOSCALE_CONFIGGets project disk autoscale config

Gets project disk autoscale config

Authentication

Connected account required

Tags

Projects
Gets a project's function combined statisticsSUPABASE_V1_GET_PROJECT_FUNCTION_COMBINED_STATSGets a project's function combined statistics

Gets a project's function combined statistics

Authentication

Connected account required

Tags

Analytics
Gets all project's logs in a single log streamSUPABASE_V1_GET_PROJECT_LOGSExecutes an SQL or LQL query on the project's unified logs stream. Either the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided. If both are not provided, only the last 1 minute of logs will be queried. The timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown. Filter by the `source` column to specify specific log sources, such as edge_logs, postgres_logs, etc. Note: SQL must be written in **ClickHouse SQL dialect**.

Executes an SQL or LQL query on the project's unified logs stream. Either the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided. If both are not provided, only the last 1 minute of logs will be queried. The timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown. Filter by the `source` column to specify specific log sources, such as edge_logs, postgres_logs, etc. Note: SQL must be written in **ClickHouse SQL dialect**.

Authentication

Connected account required

Scopes

analytics:read

Tags

Analytics
Gets project's logsSUPABASE_V1_GET_PROJECT_LOGS_ALLExecutes a SQL query on the project's logs. Either the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided. If both are not provided, only the last 1 minute of logs will be queried. The timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown. Note: Unless the `sql` parameter is provided, only edge_logs will be queried. See the [log query docs](/docs/guides/telemetry/logs?queryGroups=product&product=postgres&queryGroups=source&source=edge_logs#querying-with-the-logs-explorer:~:text=logs%20from%20the-,Sources,-drop%2Ddown%3A) for all available sources.

Executes a SQL query on the project's logs. Either the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided. If both are not provided, only the last 1 minute of logs will be queried. The timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown. Note: Unless the `sql` parameter is provided, only edge_logs will be queried. See the [log query docs](/docs/guides/telemetry/logs?queryGroups=product&product=postgres&queryGroups=source&source=edge_logs#querying-with-the-logs-explorer:~:text=logs%20from%20the-,Sources,-drop%2Ddown%3A) for all available sources.

Authentication

Connected account required

Scopes

analytics:read

Tags

Analytics
Get project's pgbouncer configSUPABASE_V1_GET_PROJECT_PGBOUNCER_CONFIGGet project's pgbouncer config

Get project's pgbouncer config

Authentication

Connected account required

Scopes

database:read

Tags

Database
Get a third-party integrationSUPABASE_V1_GET_PROJECT_TPA_INTEGRATIONGet a third-party integration

Get a third-party integration

Authentication

Connected account required

Scopes

auth:read

Tags

Auth
Gets project's usage api countsSUPABASE_V1_GET_PROJECT_USAGE_API_COUNTGets project's usage api counts

Gets project's usage api counts

Authentication

Connected account required

Tags

Analytics
Gets project's usage api requests countSUPABASE_V1_GET_PROJECT_USAGE_REQUEST_COUNTGets project's usage api requests count

Gets project's usage api requests count

Authentication

Connected account required

Tags

Analytics
Returns project's readonly mode statusSUPABASE_V1_GET_READONLY_MODE_STATUSReturns project's readonly mode status

Returns project's readonly mode status

Authentication

Connected account required

Scopes

database:read

Tags

Database
Gets realtime configurationSUPABASE_V1_GET_REALTIME_CONFIGGets realtime configuration

Gets realtime configuration

Authentication

Connected account required

Tags

Realtime
Get restore points for projectSUPABASE_V1_GET_RESTORE_POINTGet restore points for project

Get restore points for project

Authentication

Connected account required

Scopes

database:read

Tags

Database
Gets project security advisors.SUPABASE_V1_GET_SECURITY_ADVISORSThis 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 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.

Authentication

Connected account required

Scopes

database:read

Tags

Advisors
Gets project's service health statusSUPABASE_V1_GET_SERVICES_HEALTHGets project's service health status

Gets project's service health status

Authentication

Connected account required

Scopes

projects:read

Tags

Projects
[Beta] Get project's SSL enforcement configuration.SUPABASE_V1_GET_SSL_ENFORCEMENT_CONFIG[Beta] Get project's SSL enforcement configuration.

[Beta] Get project's SSL enforcement configuration.

Authentication

Connected account required

Scopes

database:read

Tags

Database
Gets project's storage configSUPABASE_V1_GET_STORAGE_CONFIGGets project's storage config

Gets project's storage config

Authentication

Connected account required

Tags

Storage
[Beta] Gets current vanity subdomain configSUPABASE_V1_GET_VANITY_SUBDOMAIN_CONFIG[Beta] Gets current vanity subdomain config

[Beta] Gets current vanity subdomain config

Authentication

Connected account required

Scopes

domains:read

Tags

Domains
List all action runsSUPABASE_V1_LIST_ACTION_RUNSReturns a paginated list of action runs of the specified project.

Returns a paginated list of action runs of the specified project.

Authentication

Connected account required

Scopes

environment:read

Tags

Environments
Lists all backupsSUPABASE_V1_LIST_ALL_BACKUPSLists all backups

Lists all backups

Authentication

Connected account required

Scopes

database:read

Tags

Database
List all database branchesSUPABASE_V1_LIST_ALL_BRANCHESReturns all database branches of the specified project.

Returns all database branches of the specified project.

Authentication

Connected account required

Scopes

environment:read

Tags

Environments
Lists all bucketsSUPABASE_V1_LIST_ALL_BUCKETSLists all buckets

Lists all buckets

Authentication

Connected account required

Scopes

storage:read

Tags

Storage
List all functionsSUPABASE_V1_LIST_ALL_FUNCTIONSReturns all functions you've previously added to the specified project.

Returns all functions you've previously added to the specified project.

Authentication

Connected account required

Scopes

edge_functions:read

Tags

Edge Functions
List all organizationsSUPABASE_V1_LIST_ALL_ORGANIZATIONSReturns a list of organizations that you currently belong to.

Returns a list of organizations that you currently belong to.

Authentication

Connected account required

Scopes

organizations:read

Tags

Organizations
List all projectsSUPABASE_V1_LIST_ALL_PROJECTSReturns a list of all projects you've previously created.

Returns a list of all projects you've previously created.

Authentication

Connected account required

Scopes

projects:read

Tags

Projects
Lists SQL snippets for the logged in userSUPABASE_V1_LIST_ALL_SNIPPETSLists SQL snippets for the logged in user

Lists SQL snippets for the logged in user

Authentication

Connected account required

Scopes

database:read

Tags

Database
Lists all SSO providersSUPABASE_V1_LIST_ALL_SSO_PROVIDERLists all SSO providers

Lists all SSO providers

Authentication

Connected account required

Scopes

auth:read

Tags

Auth
Lists available restore versions for the given projectSUPABASE_V1_LIST_AVAILABLE_RESTORE_VERSIONSLists available restore versions for the given project

Lists available restore versions for the given project

Authentication

Connected account required

Scopes

projects:read

Tags

Projects
List all user-id to role mappings for JIT accessSUPABASE_V1_LIST_JIT_ACCESSMappings of roles a user can assume in the project database

Mappings of roles a user can assume in the project database

Authentication

Connected account required

Tags

Database
List applied migration versionsSUPABASE_V1_LIST_MIGRATION_HISTORYList applied migration versions

List applied migration versions

Authentication

Connected account required

Scopes

database:read

Tags

Database
List members of an organizationSUPABASE_V1_LIST_ORGANIZATION_MEMBERSList members of an organization

List members of an organization

Authentication

Connected account required

Scopes

organizations:read

Tags

Organizations
List billing addons and compute instance selectionsSUPABASE_V1_LIST_PROJECT_ADDONSReturns 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.

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.

Authentication

Connected account required

Tags

Billing
Lists all third-party auth integrationsSUPABASE_V1_LIST_PROJECT_TPA_INTEGRATIONSLists all third-party auth integrations

Lists all third-party auth integrations

Authentication

Connected account required

Scopes

auth:read

Tags

Auth
Scrape a project's metricsSUPABASE_V1_SCRAPE_PROJECT_METRICSPrometheus scrape endpoint. Returns metrics of a customer project in the Prometheus open exposition format.

Prometheus scrape endpoint. Returns metrics of a customer project in the Prometheus open exposition format.

Authentication

Connected account required

Scopes

analytics:read

Tags

Analytics

Provider resources