Supabase integration: operations for AI agents
Supabase connects to Type.com as an integration. This page lists the 169 operations documented for Claude and Codex in Type.com: 78 read, 58 write, 33 destructive.
About Supabase
Supabase is an open-source backend-as-a-service providing a Postgres database, authentication, storage, and real-time subscription APIs for building modern applications
Categories: Developer Tools & IT
How to connect Supabase to Type.com
- Connect
- OAuth with a configured authorization client
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
169 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
169 operations listed.
Environments
- Read
Get database branch config
Fetches configurations of the specified database branch
GET /v1/branches/{branch_id_or_ref} - Read
Diffs a database branch
Diffs the specified database branch This endpoint is currently in its **Beta** stage.
GET /v1/branches/{branch_id_or_ref}/diff - Read
Count the number of action runs
Returns the total number of action runs of the specified project.
HEAD /v1/projects/{ref}/actions - Read
List all action runs
Returns a paginated list of action runs of the specified project.
GET /v1/projects/{ref}/actions - Read
Get the status of an action run
Returns the current status of the specified action run.
GET /v1/projects/{ref}/actions/{run_id} - Read
Get the logs of an action run
Returns the logs from the specified action run.
GET /v1/projects/{ref}/actions/{run_id}/logs - Read
List all database branches
Returns all database branches of the specified project.
GET /v1/projects/{ref}/branches - Read
Get a database branch
Fetches the specified database branch by its name.
GET /v1/projects/{ref}/branches/{name} - Write
Update database branch config
Updates the configuration of the specified database branch
PATCH /v1/branches/{branch_id_or_ref} - Write
Pushes a database branch
Pushes the specified database branch
POST /v1/branches/{branch_id_or_ref}/push - Write
Merges a database branch
Merges the specified database branch
POST /v1/branches/{branch_id_or_ref}/merge - Write
Resets a database branch
Resets the specified database branch
POST /v1/branches/{branch_id_or_ref}/reset - Write
Restore a scheduled branch deletion
Cancels scheduled deletion and restores the branch to active state
POST /v1/branches/{branch_id_or_ref}/restore - Write
Update the status of an action run
Updates the status of an ongoing action run.
PATCH /v1/projects/{ref}/actions/{run_id}/status - Write
Create a database branch
Creates a database branch from the specified project.
POST /v1/projects/{ref}/branches - Destructive
Delete a database 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).
DELETE /v1/branches/{branch_id_or_ref} - Destructive
Disables preview branching
Disables preview branching for the specified project
DELETE /v1/projects/{ref}/branches
Projects
- Read
List all projects
Returns a list of all projects you've previously created.
GET /v1/projects - Read
Gets the list of available regions that can be used for a new project
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 endpoint is currently in its **Beta** stage.
GET /v1/projects/available-regions - Read
Gets project's 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 endpoint is currently in its **Beta** stage.
GET /v1/projects/{ref}/network-restrictions - Read
Gets a specific project that belongs to the authenticated user
GET /v1/projects/{ref}
GET /v1/projects/{ref} - Read
Returns the project's eligibility for upgrades
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 endpoint is currently in its **Beta** stage.
GET /v1/projects/{ref}/upgrade/eligibility - Read
Gets the latest status of the project's upgrade
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 endpoint is currently in its **Beta** stage.
GET /v1/projects/{ref}/upgrade/status - Read
Gets project's service health status
GET /v1/projects/{ref}/health
GET /v1/projects/{ref}/health - Read
Lists available restore versions for the given project
GET /v1/projects/{ref}/restore
GET /v1/projects/{ref}/restore - Read
Gets project claim token
GET /v1/projects/{ref}/claim-token
GET /v1/projects/{ref}/claim-token - Read
Get database disk attributes
GET /v1/projects/{ref}/config/disk
GET /v1/projects/{ref}/config/disk - Read
Get disk utilization
GET /v1/projects/{ref}/config/disk/util
GET /v1/projects/{ref}/config/disk/util - Read
Gets project disk autoscale config
GET /v1/projects/{ref}/config/disk/autoscale
GET /v1/projects/{ref}/config/disk/autoscale - Read
Gets all projects for the given organization
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.
GET /v1/organizations/{slug}/projects - Write
Create a project
POST /v1/projects
POST /v1/projects - Write
Gets project's 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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/network-bans/retrieve - Write
Gets project's network bans with additional information about which databases they affect
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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/network-bans/retrieve/enriched - Write
Updates project's network restrictions by adding or removing CIDRs
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 endpoint is currently in its **Alpha** stage.
PATCH /v1/projects/{ref}/network-restrictions - Write
Updates project's 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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/network-restrictions/apply - Write
Updates the given project
PATCH /v1/projects/{ref}
PATCH /v1/projects/{ref} - Write
Upgrades the project's 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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/upgrade - Write
Pauses the given project
POST /v1/projects/{ref}/pause
POST /v1/projects/{ref}/pause - Write
Restarts the given project
POST /v1/projects/{ref}/restart
POST /v1/projects/{ref}/restart - Write
Restores the given project
POST /v1/projects/{ref}/restore
POST /v1/projects/{ref}/restore - Write
Cancels the given project restoration
POST /v1/projects/{ref}/restore/cancel
POST /v1/projects/{ref}/restore/cancel - Write
Creates project claim token
POST /v1/projects/{ref}/claim-token
POST /v1/projects/{ref}/claim-token - Write
Modify database disk
POST /v1/projects/{ref}/config/disk
POST /v1/projects/{ref}/config/disk - Destructive
Remove 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 endpoint is currently in its **Beta** stage.
DELETE /v1/projects/{ref}/network-bans - Destructive
Deletes the given project
DELETE /v1/projects/{ref}
DELETE /v1/projects/{ref} - Destructive
Revokes project claim token
DELETE /v1/projects/{ref}/claim-token
DELETE /v1/projects/{ref}/claim-token
Organizations
- Read
List all organizations
Returns a list of organizations that you currently belong to.
GET /v1/organizations - Read
Get entitlements for an organization
Returns the entitlements available to the organization based on their plan and any overrides.
GET /v1/organizations/{slug}/entitlements - Read
List members of an organization
GET /v1/organizations/{slug}/members
GET /v1/organizations/{slug}/members - Read
Gets information about the organization
GET /v1/organizations/{slug}
GET /v1/organizations/{slug} - Read
Gets project details for the specified organization and claim token
GET /v1/organizations/{slug}/project-claim/{token}
GET /v1/organizations/{slug}/project-claim/{token} - Write
Create an organization
POST /v1/organizations
POST /v1/organizations - Write
Claims project for the specified organization
POST /v1/organizations/{slug}/project-claim/{token}
POST /v1/organizations/{slug}/project-claim/{token}
OAuth
- Read
Authorize user through oauth
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 endpoint is currently in its **Beta** stage.
GET /v1/oauth/authorize - Read
Authorize user through oauth and claim a project
Initiates the OAuth authorization flow for the specified provider. After successful authentication, the user can claim ownership of the specified project.
GET /v1/oauth/authorize/project-claim - Write
Exchange auth code for user's access and refresh token
Supports `authorization_code`, `refresh_token`, and `urn:ietf:params:oauth:grant-type:jwt-bearer` grant types. The `jwt-bearer` grant type (IDJAG — identity-directed JWT assertion) is in beta and available on Team and Enterprise plans only. This endpoint is currently in its **Beta** stage.
POST /v1/oauth/token - Destructive
Revoke oauth app authorization and it's corresponding tokens
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 endpoint is currently in its **Beta** stage.
POST /v1/oauth/revoke
Database
- Read
Lists SQL snippets for the logged in user
GET /v1/snippets
GET /v1/snippets - Read
Gets a specific SQL snippet
GET /v1/snippets/{id}
GET /v1/snippets/{id} - Read
Get project's temporary access configuration.
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 endpoint is currently in its **Beta** stage.
GET /v1/projects/{ref}/jit-access - Read
Get project's SSL enforcement configuration.
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 endpoint is currently in its **Beta** stage.
GET /v1/projects/{ref}/ssl-enforcement - Read
Generate TypeScript types
Returns the TypeScript types of your schema for use with supabase-js.
GET /v1/projects/{ref}/types/typescript - Read
Returns project's readonly mode status
GET /v1/projects/{ref}/readonly
GET /v1/projects/{ref}/readonly - Read
List applied migration versions
GET /v1/projects/{ref}/database/migrations
GET /v1/projects/{ref}/database/migrations - Read
Fetch an existing entry from migration history
GET /v1/projects/{ref}/database/migrations/{version}
GET /v1/projects/{ref}/database/migrations/{version} - Read
Run a sql query as supabase_read_only_user
All entity references must be schema qualified. This endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/database/query/read-only - Read
Gets database metadata for the given project.
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.
GET /v1/projects/{ref}/database/context - Read
Get user-id to role mappings for JIT access
Mappings of roles a user can assume in the project database
GET /v1/projects/{ref}/database/jit - Read
List all user-id to role mappings for JIT access
Mappings of roles a user can assume in the project database
GET /v1/projects/{ref}/database/jit/list - Read
Get PostgREST OpenAPI spec
Returns the PostgREST OpenAPI specification for the project. This is the replacement for querying `/rest/v1/` directly with the anon key.
GET /v1/projects/{ref}/database/openapi - Read
Get project's pgbouncer config
GET /v1/projects/{ref}/config/database/pgbouncer
GET /v1/projects/{ref}/config/database/pgbouncer - Read
Gets project's supavisor config
GET /v1/projects/{ref}/config/database/pooler
GET /v1/projects/{ref}/config/database/pooler - Read
Gets project's Postgres config
GET /v1/projects/{ref}/config/database/postgres
GET /v1/projects/{ref}/config/database/postgres - Read
Lists all backups
GET /v1/projects/{ref}/database/backups
GET /v1/projects/{ref}/database/backups - Read
Get restore points for project
GET /v1/projects/{ref}/database/backups/restore-point
GET /v1/projects/{ref}/database/backups/restore-point - Read
Gets the backup schedule for a project
GET /v1/projects/{ref}/database/backups/schedule
GET /v1/projects/{ref}/database/backups/schedule - Write
Disables project's readonly mode for the next 15 minutes
POST /v1/projects/{ref}/readonly/temporary-disable
POST /v1/projects/{ref}/readonly/temporary-disable - Write
Set up 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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/read-replicas/setup - Write
Create a login role for CLI with temporary password
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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/cli/login-role - Write
Apply a database migration
POST /v1/projects/{ref}/database/migrations
POST /v1/projects/{ref}/database/migrations - Write
Patch an existing entry in migration history
PATCH /v1/projects/{ref}/database/migrations/{version}
PATCH /v1/projects/{ref}/database/migrations/{version} - Write
Enables Database Webhooks on the project
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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/database/webhooks/enable - Write
Updates the database password
PATCH /v1/projects/{ref}/database/password
PATCH /v1/projects/{ref}/database/password - Write
Authorize user-id to role mappings for JIT access
Authorizes the request to assume a role in the project database
POST /v1/projects/{ref}/database/jit - Write
Invites an external user to a database for JIT access
Invites the external user and sets initial roles that can be assumed and for how long
POST /v1/projects/{ref}/database/jit/invite - Write
Accepts invitation for JIT database access
Accepts the invitation to JIT database access
POST /v1/projects/{ref}/database/jit/invite/accept - Write
Updates project's supavisor config
PATCH /v1/projects/{ref}/config/database/pooler
PATCH /v1/projects/{ref}/config/database/pooler - Write
Initiates a creation of a restore point for a database
POST /v1/projects/{ref}/database/backups/restore-point
POST /v1/projects/{ref}/database/backups/restore-point - Write
Updates the backup schedule time for a project
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.
PATCH /v1/projects/{ref}/database/backups/schedule - Destructive
Update project's temporary access configuration.
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 endpoint is currently in its **Beta** stage.
PUT /v1/projects/{ref}/jit-access - Destructive
Update project's SSL enforcement configuration.
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 endpoint is currently in its **Beta** stage.
PUT /v1/projects/{ref}/ssl-enforcement - Destructive
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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/read-replicas/remove - Destructive
Delete existing login roles used by CLI
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 endpoint is currently in its **Beta** stage.
DELETE /v1/projects/{ref}/cli/login-role - Destructive
Upsert a database migration without applying
PUT /v1/projects/{ref}/database/migrations
PUT /v1/projects/{ref}/database/migrations - Destructive
Rollback database migrations and remove them from history table
DELETE /v1/projects/{ref}/database/migrations
DELETE /v1/projects/{ref}/database/migrations - Destructive
Run sql 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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/database/query - Destructive
Updates a user mapping for JIT access
Modifies the roles that can be assumed and for how long
PUT /v1/projects/{ref}/database/jit - Destructive
Deletes the invite for an external user to a database for JIT access
Revokes and deletes the invitation
DELETE /v1/projects/{ref}/database/jit/invite/{invite_id} - Destructive
Delete JIT access by user-id
Remove JIT mappings of a user, revoking all JIT database access
DELETE /v1/projects/{ref}/database/jit/{user_id} - Destructive
Updates project's Postgres config
PUT /v1/projects/{ref}/config/database/postgres
PUT /v1/projects/{ref}/config/database/postgres - Destructive
Restores a PITR backup for a database
POST /v1/projects/{ref}/database/backups/restore-pitr
POST /v1/projects/{ref}/database/backups/restore-pitr - Destructive
Restores a physical backup for a database
POST /v1/projects/{ref}/database/backups/restore
POST /v1/projects/{ref}/database/backups/restore - Destructive
Initiates an undo to a given restore point
POST /v1/projects/{ref}/database/backups/undo
POST /v1/projects/{ref}/database/backups/undo
Profile
- Read
Gets the user's profile
GET /v1/profile
GET /v1/profile
Secrets
- Read
Get project api keys
GET /v1/projects/{ref}/api-keys
GET /v1/projects/{ref}/api-keys - Read
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.
Check whether JWT based legacy (anon, servicerole) API keys are enabled. This API endpoint will be removed in the future, check for HTTP 404 Not Found.
GET /v1/projects/{ref}/api-keys/legacy - Read
Get API key
GET /v1/projects/{ref}/api-keys/{id}
GET /v1/projects/{ref}/api-keys/{id} - Read
Gets project's 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 endpoint is currently in its **Beta** stage.
GET /v1/projects/{ref}/pgsodium - Read
List all secrets
Returns all secrets you've previously added to the specified project.
GET /v1/projects/{ref}/secrets - Write
Creates a new API key for the project
POST /v1/projects/{ref}/api-keys
POST /v1/projects/{ref}/api-keys - Write
Updates an API key for the project
PATCH /v1/projects/{ref}/api-keys/{id}
PATCH /v1/projects/{ref}/api-keys/{id} - Write
Bulk create secrets
Creates multiple secrets and adds them to the specified project.
POST /v1/projects/{ref}/secrets - Destructive
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.
Disable or re-enable JWT based legacy (anon, servicerole) API keys. This API endpoint will be removed in the future, check for HTTP 404 Not Found.
PUT /v1/projects/{ref}/api-keys/legacy - Destructive
Deletes an API key for the project
DELETE /v1/projects/{ref}/api-keys/{id}
DELETE /v1/projects/{ref}/api-keys/{id} - Destructive
Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.
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 endpoint is currently in its **Beta** stage.
PUT /v1/projects/{ref}/pgsodium - Destructive
Bulk delete secrets
Deletes all secrets with the given names from the specified project
DELETE /v1/projects/{ref}/secrets
Domains
- Read
Gets project's custom 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 endpoint is currently in its **Beta** stage.
GET /v1/projects/{ref}/custom-hostname - Read
Gets current 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 endpoint is currently in its **Beta** stage.
GET /v1/projects/{ref}/vanity-subdomain - Write
Updates project's custom hostname configuration
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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/custom-hostname/initialize - Write
Attempts to verify the DNS configuration for project's custom hostname configuration
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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/custom-hostname/reverify - Write
Activates a custom hostname for a project.
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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/custom-hostname/activate - Write
Checks 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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/vanity-subdomain/check-availability - Write
Activates a vanity subdomain for a project.
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 endpoint is currently in its **Beta** stage.
POST /v1/projects/{ref}/vanity-subdomain/activate - Destructive
Deletes a project's custom hostname configuration
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 endpoint is currently in its **Beta** stage.
DELETE /v1/projects/{ref}/custom-hostname - Destructive
Deletes a project's vanity subdomain configuration
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 endpoint is currently in its **Beta** stage.
DELETE /v1/projects/{ref}/vanity-subdomain
Rest
- Read
Gets project's postgrest config
GET /v1/projects/{ref}/postgrest
GET /v1/projects/{ref}/postgrest - Write
Updates project's postgrest config
PATCH /v1/projects/{ref}/postgrest
PATCH /v1/projects/{ref}/postgrest
Auth
- Read
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.
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.
GET /v1/projects/{ref}/config/auth/signing-keys/legacy - Read
List all signing keys for the project
GET /v1/projects/{ref}/config/auth/signing-keys
GET /v1/projects/{ref}/config/auth/signing-keys - Read
Get information about a signing key
GET /v1/projects/{ref}/config/auth/signing-keys/{id}
GET /v1/projects/{ref}/config/auth/signing-keys/{id} - Read
Gets project's auth config
GET /v1/projects/{ref}/config/auth
GET /v1/projects/{ref}/config/auth - Read
Lists all third-party auth integrations
GET /v1/projects/{ref}/config/auth/third-party-auth
GET /v1/projects/{ref}/config/auth/third-party-auth - Read
Get a third-party integration
GET /v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}
GET /v1/projects/{ref}/config/auth/third-party-auth/{tpa_id} - Read
Lists all SSO providers
GET /v1/projects/{ref}/config/auth/sso/providers
GET /v1/projects/{ref}/config/auth/sso/providers - Read
Gets a SSO provider by its UUID
GET /v1/projects/{ref}/config/auth/sso/providers/{provider_id}
GET /v1/projects/{ref}/config/auth/sso/providers/{provider_id} - Write
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.
Set up the project's existing JWT secret as an inuse JWT signing key. This endpoint will be removed in the future always check for HTTP 404 Not Found.
POST /v1/projects/{ref}/config/auth/signing-keys/legacy - Write
Create a new signing key for the project in standby status
POST /v1/projects/{ref}/config/auth/signing-keys
POST /v1/projects/{ref}/config/auth/signing-keys - Write
Update a signing key, mainly its status
PATCH /v1/projects/{ref}/config/auth/signing-keys/{id}
PATCH /v1/projects/{ref}/config/auth/signing-keys/{id} - Write
Updates a project's auth config
PATCH /v1/projects/{ref}/config/auth
PATCH /v1/projects/{ref}/config/auth - Write
Creates a new third-party auth integration
POST /v1/projects/{ref}/config/auth/third-party-auth
POST /v1/projects/{ref}/config/auth/third-party-auth - Write
Creates a new SSO provider
POST /v1/projects/{ref}/config/auth/sso/providers
POST /v1/projects/{ref}/config/auth/sso/providers - Destructive
Remove a signing key from a project. Only possible if the key has been in revoked status for a while.
DELETE /v1/projects/{ref}/config/auth/signing-keys/{id}
DELETE /v1/projects/{ref}/config/auth/signing-keys/{id} - Destructive
Removes a third-party auth integration
DELETE /v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}
DELETE /v1/projects/{ref}/config/auth/third-party-auth/{tpa_id} - Destructive
Updates a SSO provider by its UUID
PUT /v1/projects/{ref}/config/auth/sso/providers/{provider_id}
PUT /v1/projects/{ref}/config/auth/sso/providers/{provider_id} - Destructive
Removes a SSO provider by its UUID
DELETE /v1/projects/{ref}/config/auth/sso/providers/{provider_id}
DELETE /v1/projects/{ref}/config/auth/sso/providers/{provider_id}
Billing
- Read
List billing addons and compute instance selections
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.
GET /v1/projects/{ref}/billing/addons - Write
Apply or update billing addons, including compute instance size
Selects an addon variant, for example scaling the project’s compute instance up or down, and applies it to the project.
PATCH /v1/projects/{ref}/billing/addons - Destructive
Remove billing addons or revert compute instance sizing
Disables the selected addon variant, including rolling the compute instance back to its previous size.
DELETE /v1/projects/{ref}/billing/addons/{addon_variant}
Advisors
- Read
Gets project 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.
GET /v1/projects/{ref}/advisors/performance - Read
Gets project 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.
GET /v1/projects/{ref}/advisors/security
Analytics
- Read
Gets all project's logs in a single log stream
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**.
GET /v1/projects/{ref}/analytics/endpoints/logs - Read
Gets project's usage api counts
GET /v1/projects/{ref}/analytics/endpoints/usage.api-counts
GET /v1/projects/{ref}/analytics/endpoints/usage.api-counts - Read
Gets project's usage api requests count
GET /v1/projects/{ref}/analytics/endpoints/usage.api-requests-count
GET /v1/projects/{ref}/analytics/endpoints/usage.api-requests-count - Read
Gets a project's function combined statistics
GET /v1/projects/{ref}/analytics/endpoints/functions.combined-stats
GET /v1/projects/{ref}/analytics/endpoints/functions.combined-stats - Read
Scrape a project's metrics
Prometheus scrape endpoint. Returns metrics of a customer project in the Prometheus open exposition format.
GET /v1/projects/{ref}/analytics/endpoints/metrics
Edge Functions
- Read
List all functions
Returns all functions you've previously added to the specified project.
GET /v1/projects/{ref}/functions - Read
Retrieve a function
Retrieves a function with the specified slug and project.
GET /v1/projects/{ref}/functions/{function_slug} - Read
Retrieve a function body
Retrieves a function body for the specified slug and project.
GET /v1/projects/{ref}/functions/{function_slug}/body - Write
Create a function (deprecated)
This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project.
POST /v1/projects/{ref}/functions - Write
Deploy a function
A new endpoint to deploy functions. It will create if function does not exist.
POST /v1/projects/{ref}/functions/deploy - Write
Update a function
Updates a function with the specified slug and project.
PATCH /v1/projects/{ref}/functions/{function_slug} - Destructive
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.
PUT /v1/projects/{ref}/functions - Destructive
Delete a function
Deletes a function with the specified slug from the specified project.
DELETE /v1/projects/{ref}/functions/{function_slug}
Storage
- Read
Lists all buckets
GET /v1/projects/{ref}/storage/buckets
GET /v1/projects/{ref}/storage/buckets - Read
Gets project's storage config
GET /v1/projects/{ref}/config/storage
GET /v1/projects/{ref}/config/storage - Write
Updates project's storage config
PATCH /v1/projects/{ref}/config/storage
PATCH /v1/projects/{ref}/config/storage
Realtime
- Read
Gets realtime configuration
GET /v1/projects/{ref}/config/realtime
GET /v1/projects/{ref}/config/realtime - Write
Updates realtime configuration
PATCH /v1/projects/{ref}/config/realtime
PATCH /v1/projects/{ref}/config/realtime - Write
Shutdowns realtime connections for a project
POST /v1/projects/{ref}/config/realtime/shutdown
POST /v1/projects/{ref}/config/realtime/shutdown
No operations match.
Get started
- Open Space settings → Connections and search for Supabase.
- Connect your account and add the connection to the Space.
- Ask for what you need in any thread in that Space.
See How connections work for access and permissions, or browse all integrations.