The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
'/v1/branches/{branch_id_or_ref}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Get database branch config
* @description Fetches configurations of the specified database branch
*/
get: operations['v1-get-a-branch-config']
put?: never
post?: never
/**
* Delete a database branch
* @description 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: operations['v1-delete-a-branch']
options?: never
head?: never
/**
* Update database branch config
* @description Updates the configuration of the specified database branch
*/
patch: operations['v1-update-a-branch-config']
trace?: never
}
'/v1/branches/{branch_id_or_ref}/diff': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Diffs a database branch
* @description Diffs the specified database branch
*
* This endpoint is currently in its **Beta** stage.
*/
get: operations['v1-diff-a-branch']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/branches/{branch_id_or_ref}/merge': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Merges a database branch
* @description Merges the specified database branch
*/
post: operations['v1-merge-a-branch']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/branches/{branch_id_or_ref}/push': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Pushes a database branch
* @description Pushes the specified database branch
*/
post: operations['v1-push-a-branch']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/branches/{branch_id_or_ref}/reset': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Resets a database branch
* @description Resets the specified database branch
*/
post: operations['v1-reset-a-branch']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/branches/{branch_id_or_ref}/restore': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Restore a scheduled branch deletion
* @description Cancels scheduled deletion and restores the branch to active state
*/
post: operations['v1-restore-a-branch']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/oauth/authorize': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Authorize user through oauth
* @description 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: operations['v1-authorize-user']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/oauth/authorize/project-claim': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Authorize user through oauth and claim a project
* @description Initiates the OAuth authorization flow for the specified provider. After successful authentication, the user can claim ownership of the specified project.
*/
get: operations['v1-oauth-authorize-project-claim']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/oauth/revoke': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Revoke oauth app authorization and it's corresponding tokens
* @description 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: operations['v1-revoke-token']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/oauth/token': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Exchange auth code for user's access and refresh token
* @description 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: operations['v1-exchange-oauth-token']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/organizations': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* List all organizations
* @description Returns a list of organizations that you currently belong to.
*/
get: operations['v1-list-all-organizations']
put?: never
/** Create an organization */
post: operations['v1-create-an-organization']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/organizations/{slug}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets information about the organization */
get: operations['v1-get-an-organization']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/organizations/{slug}/entitlements': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Get entitlements for an organization
* @description Returns the entitlements available to the organization based on their plan and any overrides.
*/
get: operations['v1-get-organization-entitlements']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/organizations/{slug}/members': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** List members of an organization */
get: operations['v1-list-organization-members']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/organizations/{slug}/project-claim/{token}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project details for the specified organization and claim token */
get: operations['v1-get-organization-project-claim']
put?: never
/** Claims project for the specified organization */
post: operations['v1-claim-project-for-organization']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/organizations/{slug}/projects': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets all projects for the given organization
* @description 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: operations['v1-get-all-projects-for-organization']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/profile': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets the user's profile */
get: operations['v1-get-profile']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* List all projects
* @description Returns a list of all projects you've previously created.
*/
get: operations['v1-list-all-projects']
put?: never
/** Create a project */
post: operations['v1-create-a-project']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets a specific project that belongs to the authenticated user */
get: operations['v1-get-project']
put?: never
post?: never
/** Deletes the given project */
delete: operations['v1-delete-a-project']
options?: never
head?: never
/** Updates the given project */
patch: operations['v1-update-a-project']
trace?: never
}
'/v1/projects/{ref}/actions': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* List all action runs
* @description Returns a paginated list of action runs of the specified project.
*/
get: operations['v1-list-action-runs']
put?: never
post?: never
delete?: never
options?: never
/**
* Count the number of action runs
* @description Returns the total number of action runs of the specified project.
*/
head: operations['v1-count-action-runs']
patch?: never
trace?: never
}
'/v1/projects/{ref}/actions/{run_id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Get the status of an action run
* @description Returns the current status of the specified action run.
*/
get: operations['v1-get-action-run']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/actions/{run_id}/logs': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Get the logs of an action run
* @description Returns the logs from the specified action run.
*/
get: operations['v1-get-action-run-logs']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/actions/{run_id}/status': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post?: never
delete?: never
options?: never
head?: never
/**
* Update the status of an action run
* @description Updates the status of an ongoing action run.
*/
patch: operations['v1-update-action-run-status']
trace?: never
}
'/v1/projects/{ref}/advisors/performance': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets project performance advisors.
* @description 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: operations['v1-get-performance-advisors']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/advisors/security': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets project security advisors.
* @description 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: operations['v1-get-security-advisors']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/analytics/endpoints/functions.combined-stats': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets a project's function combined statistics */
get: operations['v1-get-project-function-combined-stats']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/analytics/endpoints/logs': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets all project's logs in a single log stream
* @description 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: operations['v1-get-project-logs']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/analytics/endpoints/logs.all': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets project's logs
* @deprecated
* @description This endpoint has been removed and always responds with `410 Gone`. Use `GET /v1/projects/{ref}/analytics/endpoints/logs` instead. See the [migration guide](https://supabase.com/changelog/48235-migration-of-supabase-management-api-logs-all-analytics-endpoint-to-logs-endpoint).
*/
get: operations['v1-get-project-logs-all']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/analytics/endpoints/metrics': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Scrape a project's metrics
* @description Prometheus scrape endpoint. Returns metrics of a customer project in the Prometheus open exposition format.
*/
get: operations['v1-scrape-project-metrics']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/analytics/endpoints/usage.api-counts': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project's usage api counts */
get: operations['v1-get-project-usage-api-count']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/analytics/endpoints/usage.api-requests-count': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project's usage api requests count */
get: operations['v1-get-project-usage-request-count']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/api-keys': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Get project api keys */
get: operations['v1-get-project-api-keys']
put?: never
/** Creates a new API key for the project */
post: operations['v1-create-project-api-key']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/api-keys/{id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Get API key */
get: operations['v1-get-project-api-key']
put?: never
post?: never
/** Deletes an API key for the project */
delete: operations['v1-delete-project-api-key']
options?: never
head?: never
/** Updates an API key for the project */
patch: operations['v1-update-project-api-key']
trace?: never
}
'/v1/projects/{ref}/api-keys/legacy': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** 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. */
get: operations['v1-get-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. */
put: operations['v1-update-project-legacy-api-keys']
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/billing/addons': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* List billing addons and compute instance selections
* @description 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: operations['v1-list-project-addons']
put?: never
post?: never
delete?: never
options?: never
head?: never
/**
* Apply or update billing addons, including compute instance size
* @description Selects an addon variant, for example scaling the project’s compute instance up or down, and applies it to the project.
*/
patch: operations['v1-apply-project-addon']
trace?: never
}
'/v1/projects/{ref}/billing/addons/{addon_variant}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post?: never
/**
* Remove billing addons or revert compute instance sizing
* @description Disables the selected addon variant, including rolling the compute instance back to its previous size.
*/
delete: operations['v1-remove-project-addon']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/branches': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* List all database branches
* @description Returns all database branches of the specified project.
*/
get: operations['v1-list-all-branches']
put?: never
/**
* Create a database branch
* @description Creates a database branch from the specified project.
*/
post: operations['v1-create-a-branch']
/**
* Disables preview branching
* @description Disables preview branching for the specified project
*/
delete: operations['v1-disable-preview-branching']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/branches/{name}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Get a database branch
* @description Fetches the specified database branch by its name.
*/
get: operations['v1-get-a-branch']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/claim-token': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project claim token */
get: operations['v1-get-project-claim-token']
put?: never
/** Creates project claim token */
post: operations['v1-create-project-claim-token']
/** Revokes project claim token */
delete: operations['v1-delete-project-claim-token']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/cli/login-role': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Create a login role for CLI with temporary password
* @description 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: operations['v1-create-login-role']
/**
* Delete existing login roles used by CLI
* @description 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: operations['v1-delete-login-roles']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/auth': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project's auth config */
get: operations['v1-get-auth-service-config']
put?: never
post?: never
delete?: never
options?: never
head?: never
/** Updates a project's auth config */
patch: operations['v1-update-auth-service-config']
trace?: never
}
'/v1/projects/{ref}/config/auth/signing-keys': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** List all signing keys for the project */
get: operations['v1-get-project-signing-keys']
put?: never
/** Create a new signing key for the project in standby status */
post: operations['v1-create-project-signing-key']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/auth/signing-keys/{id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Get information about a signing key */
get: operations['v1-get-project-signing-key']
put?: never
post?: never
/** Remove a signing key from a project. Only possible if the key has been in revoked status for a while. */
delete: operations['v1-remove-project-signing-key']
options?: never
head?: never
/** Update a signing key, mainly its status */
patch: operations['v1-update-project-signing-key']
trace?: never
}
'/v1/projects/{ref}/config/auth/signing-keys/legacy': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** 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: operations['v1-get-legacy-signing-key']
put?: never
/** 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. */
post: operations['v1-create-legacy-signing-key']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/auth/sso/providers': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Lists all SSO providers */
get: operations['v1-list-all-sso-provider']
put?: never
/** Creates a new SSO provider */
post: operations['v1-create-a-sso-provider']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/auth/sso/providers/{provider_id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets a SSO provider by its UUID */
get: operations['v1-get-a-sso-provider']
/** Updates a SSO provider by its UUID */
put: operations['v1-update-a-sso-provider']
post?: never
/** Removes a SSO provider by its UUID */
delete: operations['v1-delete-a-sso-provider']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/auth/third-party-auth': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Lists all third-party auth integrations */
get: operations['v1-list-project-tpa-integrations']
put?: never
/** Creates a new third-party auth integration */
post: operations['v1-create-project-tpa-integration']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Get a third-party integration */
get: operations['v1-get-project-tpa-integration']
put?: never
post?: never
/** Removes a third-party auth integration */
delete: operations['v1-delete-project-tpa-integration']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/database/pgbouncer': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Get project's pgbouncer config */
get: operations['v1-get-project-pgbouncer-config']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/database/pooler': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project's supavisor config */
get: operations['v1-get-pooler-config']
put?: never
post?: never
delete?: never
options?: never
head?: never
/** Updates project's supavisor config */
patch: operations['v1-update-pooler-config']
trace?: never
}
'/v1/projects/{ref}/config/database/postgres': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project's Postgres config */
get: operations['v1-get-postgres-config']
/** Updates project's Postgres config */
put: operations['v1-update-postgres-config']
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/disk': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Get database disk attributes */
get: operations['v1-get-database-disk']
put?: never
/** Modify database disk */
post: operations['v1-modify-database-disk']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/disk/autoscale': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project disk autoscale config */
get: operations['v1-get-project-disk-autoscale-config']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/disk/util': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Get disk utilization */
get: operations['v1-get-disk-utilization']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/realtime': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets realtime configuration */
get: operations['v1-get-realtime-config']
put?: never
post?: never
delete?: never
options?: never
head?: never
/** Updates realtime configuration */
patch: operations['v1-update-realtime-config']
trace?: never
}
'/v1/projects/{ref}/config/realtime/shutdown': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/** Shutdowns realtime connections for a project */
post: operations['v1-shutdown-realtime']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/config/storage': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project's storage config */
get: operations['v1-get-storage-config']
put?: never
post?: never
delete?: never
options?: never
head?: never
/** Updates project's storage config */
patch: operations['v1-update-storage-config']
trace?: never
}
'/v1/projects/{ref}/custom-hostname': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets project's custom hostname config
* @description 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: operations['v1-get-hostname-config']
put?: never
post?: never
/**
* Deletes a project's custom hostname configuration
* @description 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: operations['v1-Delete hostname config']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/custom-hostname/activate': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Activates a custom hostname for a project.
* @description 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: operations['v1-activate-custom-hostname']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/custom-hostname/initialize': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Updates project's custom hostname configuration
* @description 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: operations['v1-update-hostname-config']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/custom-hostname/reverify': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Attempts to verify the DNS configuration for project's custom hostname configuration
* @description 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: operations['v1-verify-dns-config']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/backups': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Lists all backups */
get: operations['v1-list-all-backups']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/backups/restore': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/** Restores a physical backup for a database */
post: operations['v1-restore-physical-backup']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/backups/restore-pitr': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/** Restores a PITR backup for a database */
post: operations['v1-restore-pitr-backup']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/backups/restore-point': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Get restore points for project */
get: operations['v1-get-restore-point']
put?: never
/** Initiates a creation of a restore point for a database */
post: operations['v1-create-restore-point']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/backups/schedule': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets the backup schedule for a project */
get: operations['v1-get-backup-schedule']
put?: never
post?: never
delete?: never
options?: never
head?: never
/**
* Updates the backup schedule time for a project
* @description 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: operations['v1-update-backup-schedule']
trace?: never
}
'/v1/projects/{ref}/database/backups/undo': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/** Initiates an undo to a given restore point */
post: operations['v1-undo']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/context': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets database metadata for the given project.
* @description 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: operations['v1-get-database-metadata']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/jit': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Get user-id to role mappings for JIT access
* @description Mappings of roles a user can assume in the project database
*/
get: operations['v1-get-jit-access']
/**
* Updates a user mapping for JIT access
* @description Modifies the roles that can be assumed and for how long
*/
put: operations['v1-update-jit-access']
/**
* Authorize user-id to role mappings for JIT access
* @description Authorizes the request to assume a role in the project database
*/
post: operations['v1-authorize-jit-access']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/jit/{user_id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post?: never
/**
* Delete JIT access by user-id
* @description Remove JIT mappings of a user, revoking all JIT database access
*/
delete: operations['v1-delete-jit-access']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/jit/invite': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Invites an external user to a database for JIT access
* @description Invites the external user and sets initial roles that can be assumed and for how long
*/
post: operations['v1-invite-external-jit-access']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/jit/invite/{invite_id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post?: never
/**
* Deletes the invite for an external user to a database for JIT access
* @description Revokes and deletes the invitation
*/
delete: operations['v1-delete-invite-external-jit-access']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/jit/invite/accept': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Accepts invitation for JIT database access
* @description Accepts the invitation to JIT database access
*/
post: operations['v1-accept-invite-external-jit-access']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/jit/list': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* List all user-id to role mappings for JIT access
* @description Mappings of roles a user can assume in the project database
*/
get: operations['v1-list-jit-access']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/migrations': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** List applied migration versions */
get: operations['v1-list-migration-history']
/** Upsert a database migration without applying */
put: operations['v1-upsert-a-migration']
/** Apply a database migration */
post: operations['v1-apply-a-migration']
/** Rollback database migrations and remove them from history table */
delete: operations['v1-rollback-migrations']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/migrations/{version}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Fetch an existing entry from migration history */
get: operations['v1-get-a-migration']
put?: never
post?: never
delete?: never
options?: never
head?: never
/** Patch an existing entry in migration history */
patch: operations['v1-patch-a-migration']
trace?: never
}
'/v1/projects/{ref}/database/openapi': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Get PostgREST OpenAPI spec
* @description Returns the PostgREST OpenAPI specification for the project. This is the replacement for querying `/rest/v1/` directly with the anon key.
*/
get: operations['v1-get-database-openapi']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/password': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post?: never
delete?: never
options?: never
head?: never
/** Updates the database password */
patch: operations['v1-update-database-password']
trace?: never
}
'/v1/projects/{ref}/database/query': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Run sql query
* @description 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: operations['v1-run-a-query']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/query/read-only': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Run a sql query as supabase_read_only_user
* @description All entity references must be schema qualified.
*
* This endpoint is currently in its **Beta** stage.
*/
post: operations['v1-read-only-query']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/database/webhooks/enable': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Enables Database Webhooks on the project
* @description 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: operations['v1-enable-database-webhook']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/functions': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* List all functions
* @description Returns all functions you've previously added to the specified project.
*/
get: operations['v1-list-all-functions']
/**
* Bulk update functions
* @description 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: operations['v1-bulk-update-functions']
/**
* Create a function
* @deprecated
* @description This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project.
*/
post: operations['v1-create-a-function']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/functions/{function_slug}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Retrieve a function
* @description Retrieves a function with the specified slug and project.
*/
get: operations['v1-get-a-function']
put?: never
post?: never
/**
* Delete a function
* @description Deletes a function with the specified slug from the specified project.
*/
delete: operations['v1-delete-a-function']
options?: never
head?: never
/**
* Update a function
* @description Updates a function with the specified slug and project.
*/
patch: operations['v1-update-a-function']
trace?: never
}
'/v1/projects/{ref}/functions/{function_slug}/body': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Retrieve a function body
* @description Retrieves a function body for the specified slug and project.
*/
get: operations['v1-get-a-function-body']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/functions/deploy': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Deploy a function
* @description A new endpoint to deploy functions. It will create if function does not exist.
*/
post: operations['v1-deploy-a-function']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/health': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project's service health status */
get: operations['v1-get-services-health']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/jit-access': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Get project's temporary access configuration.
* @description 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: operations['v1-get-jit-access-config']
/**
* Update project's temporary access configuration.
* @description 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: operations['v1-update-jit-access-config']
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/network-bans': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
post?: never
/**
* Remove network bans.
* @description 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: operations['v1-delete-network-bans']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/network-bans/retrieve': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Gets project's network bans
* @description 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: operations['v1-list-all-network-bans']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/network-bans/retrieve/enriched': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Gets project's network bans with additional information about which databases they affect
* @description 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: operations['v1-list-all-network-bans-enriched']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/network-restrictions': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets project's network restrictions
* @description 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: operations['v1-get-network-restrictions']
put?: never
post?: never
delete?: never
options?: never
head?: never
/**
* Updates project's network restrictions by adding or removing CIDRs
* @description 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: operations['v1-patch-network-restrictions']
trace?: never
}
'/v1/projects/{ref}/network-restrictions/apply': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Updates project's network restrictions
* @description 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: operations['v1-update-network-restrictions']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/pause': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/** Pauses the given project */
post: operations['v1-pause-a-project']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/pgsodium': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets project's pgsodium config
* @description 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: operations['v1-get-pgsodium-config']
/**
* Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.
* @description 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: operations['v1-update-pgsodium-config']
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/postgrest': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets project's postgrest config */
get: operations['v1-get-postgrest-service-config']
put?: never
post?: never
delete?: never
options?: never
head?: never
/** Updates project's postgrest config */
patch: operations['v1-update-postgrest-service-config']
trace?: never
}
'/v1/projects/{ref}/read-replicas/remove': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Remove a read replica
* @description 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: operations['v1-remove-a-read-replica']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/read-replicas/setup': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Set up a read replica
* @description 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: operations['v1-setup-a-read-replica']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/readonly': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Returns project's readonly mode status */
get: operations['v1-get-readonly-mode-status']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/readonly/temporary-disable': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/** Disables project's readonly mode for the next 15 minutes */
post: operations['v1-disable-readonly-mode-temporarily']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/restart': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/** Restarts the given project */
post: operations['v1-restart-a-project']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/restore': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Lists available restore versions for the given project */
get: operations['v1-list-available-restore-versions']
put?: never
/** Restores the given project */
post: operations['v1-restore-a-project']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/restore/cancel': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/** Cancels the given project restoration */
post: operations['v1-cancel-a-project-restoration']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/secrets': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* List all secrets
* @description Returns all secrets you've previously added to the specified project.
*/
get: operations['v1-list-all-secrets']
put?: never
/**
* Bulk create secrets
* @description Creates multiple secrets and adds them to the specified project.
*/
post: operations['v1-bulk-create-secrets']
/**
* Bulk delete secrets
* @description Deletes all secrets with the given names from the specified project
*/
delete: operations['v1-bulk-delete-secrets']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/ssl-enforcement': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Get project's SSL enforcement configuration.
* @description 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: operations['v1-get-ssl-enforcement-config']
/**
* Update project's SSL enforcement configuration.
* @description 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: operations['v1-update-ssl-enforcement-config']
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/storage/buckets': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Lists all buckets */
get: operations['v1-list-all-buckets']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/types/typescript': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Generate TypeScript types
* @description Returns the TypeScript types of your schema for use with supabase-js.
*/
get: operations['v1-generate-typescript-types']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/upgrade': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Upgrades the project's Postgres version
* @description 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: operations['v1-upgrade-postgres-version']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/upgrade/eligibility': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Returns the project's eligibility for upgrades
* @description 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: operations['v1-get-postgres-upgrade-eligibility']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/upgrade/status': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets the latest status of the project's upgrade
* @description 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: operations['v1-get-postgres-upgrade-status']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/vanity-subdomain': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets current vanity subdomain config
* @description 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: operations['v1-get-vanity-subdomain-config']
put?: never
post?: never
/**
* Deletes a project's vanity subdomain configuration
* @description 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: operations['v1-deactivate-vanity-subdomain-config']
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/vanity-subdomain/activate': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Activates a vanity subdomain for a project.
* @description 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: operations['v1-activate-vanity-subdomain-config']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/{ref}/vanity-subdomain/check-availability': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
get?: never
put?: never
/**
* Checks vanity subdomain availability
* @description 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: operations['v1-check-vanity-subdomain-availability']
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/projects/available-regions': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/**
* Gets the list of available regions that can be used for a new project
* @description 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: operations['v1-get-available-regions']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/snippets': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Lists SQL snippets for the logged in user */
get: operations['v1-list-all-snippets']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
'/v1/snippets/{id}': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
/** Gets a specific SQL snippet */
get: operations['v1-get-a-snippet']
put?: never
post?: never
delete?: never
options?: never
head?: never
patch?: never
trace?: never
}
}
export type webhooks = Record<string, never>
export interface components {
schemas: {
/** @example {
* "email": "[email protected]",
* "token": ""
* } */
AcceptInviteExternalUserJitAccessBody: {
/** Format: email */
email: string
token: string
}
ActionRunResponse_Output: {
branch_id: string
check_run_id: number | null
created_at: string
git_config?: unknown
id: string
run_steps: {
created_at: string
/** @enum {string} */
name: 'clone' | 'pull' | 'health' | 'configure' | 'migrate' | 'seed' | 'deploy'
/** @enum {string} */
status: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
updated_at: string
}[]
updated_at: string
workdir: string | null
}
ActivateVanitySubdomainResponse_Output: {
custom_domain: string
}
AnalyticsResponse_Output: {
error?:
| string
| {
code: number
errors: {
domain: string
location: string
locationType: string
message: string
reason: string
}[]
message: string
status: string
}
result?: unknown[]
}
ApiKeyResponse_Output: {
api_key?: string | null
description?: string | null
hash?: string | null
id?: string | null
/** Format: date-time */
inserted_at?: string | null
name: string
prefix?: string | null
secret_jwt_template?: {
[key: string]: unknown
} | null
/** @enum {string|null} */
type?: 'legacy' | 'publishable' | 'secret' | null
/** Format: date-time */
updated_at?: string | null
}
/** @example {
* "addon_variant": "pitr_7",
* "addon_type": "pitr"
* } */
ApplyProjectAddonBody: {
/** @enum {string} */
addon_type:
| 'custom_domain'
| 'compute_instance'
| 'pitr'
| 'ipv4'
| 'auth_mfa_phone'
| 'auth_mfa_web_authn'
| 'log_drain'
| 'etl_pipeline'
addon_variant:
| (
| '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'
)
| 'cd_default'
| ('pitr_7' | 'pitr_14' | 'pitr_28')
| 'ipv4_default'
}
AuthConfigResponse_Output: {
api_max_request_duration: number | null
custom_oauth_enabled: boolean
custom_oauth_max_providers: number
db_max_pool_size: number | null
/** @enum {string|null} */
db_max_pool_size_unit: 'connections' | 'percent' | null
disable_signup: boolean | null
external_anonymous_users_enabled: boolean | null
external_apple_additional_client_ids: string | null
external_apple_client_id: string | null
external_apple_email_optional: boolean | null
external_apple_enabled: boolean | null
external_apple_secret: string | null
external_azure_client_id: string | null
external_azure_email_optional: boolean | null
external_azure_enabled: boolean | null
external_azure_secret: string | null
external_azure_url: string | null
external_bitbucket_client_id: string | null
external_bitbucket_email_optional: boolean | null
external_bitbucket_enabled: boolean | null
external_bitbucket_secret: string | null
external_discord_client_id: string | null
external_discord_email_optional: boolean | null
external_discord_enabled: boolean | null
external_discord_secret: string | null
external_email_enabled: boolean | null
external_facebook_client_id: string | null
external_facebook_email_optional: boolean | null
external_facebook_enabled: boolean | null
external_facebook_secret: string | null
external_figma_client_id: string | null
external_figma_email_optional: boolean | null
external_figma_enabled: boolean | null
external_figma_secret: string | null
external_github_client_id: string | null
external_github_email_optional: boolean | null
external_github_enabled: boolean | null
external_github_secret: string | null
external_gitlab_client_id: string | null
external_gitlab_email_optional: boolean | null
external_gitlab_enabled: boolean | null
external_gitlab_secret: string | null
external_gitlab_url: string | null
external_google_additional_client_ids: string | null
external_google_client_id: string | null
external_google_email_optional: boolean | null
external_google_enabled: boolean | null
external_google_secret: string | null
external_google_skip_nonce_check: boolean | null
external_kakao_client_id: string | null
external_kakao_email_optional: boolean | null
external_kakao_enabled: boolean | null
external_kakao_secret: string | null
external_keycloak_client_id: string | null
external_keycloak_email_optional: boolean | null
external_keycloak_enabled: boolean | null
external_keycloak_secret: string | null
external_keycloak_url: string | null
external_linkedin_oidc_client_id: string | null
external_linkedin_oidc_email_optional: boolean | null
external_linkedin_oidc_enabled: boolean | null
external_linkedin_oidc_secret: string | null
external_notion_client_id: string | null
external_notion_email_optional: boolean | null
external_notion_enabled: boolean | null
external_notion_secret: string | null
external_phone_enabled: boolean | null
external_slack_client_id: string | null
external_slack_email_optional: boolean | null
external_slack_enabled: boolean | null
external_slack_oidc_client_id: string | null
external_slack_oidc_email_optional: boolean | null
external_slack_oidc_enabled: boolean | null
external_slack_oidc_secret: string | null
external_slack_secret: string | null
external_spotify_client_id: string | null
external_spotify_email_optional: boolean | null
external_spotify_enabled: boolean | null
external_spotify_secret: string | null
external_twitch_client_id: string | null
external_twitch_email_optional: boolean | null
external_twitch_enabled: boolean | null
external_twitch_secret: string | null
external_twitter_client_id: string | null
external_twitter_email_optional: boolean | null
external_twitter_enabled: boolean | null
external_twitter_secret: string | null
external_web3_ethereum_enabled: boolean | null
external_web3_solana_enabled: boolean | null
external_workos_client_id: string | null
external_workos_enabled: boolean | null
external_workos_secret: string | null
external_workos_url: string | null
external_x_client_id: string | null
external_x_email_optional: boolean | null
external_x_enabled: boolean | null
external_x_secret: string | null
external_zoom_client_id: string | null
external_zoom_email_optional: boolean | null
external_zoom_enabled: boolean | null
external_zoom_secret: string | null
hook_after_user_created_enabled: boolean | null
hook_after_user_created_secrets: string | null
hook_after_user_created_uri: string | null
hook_before_user_created_enabled: boolean | null
hook_before_user_created_secrets: string | null
hook_before_user_created_uri: string | null
hook_custom_access_token_enabled: boolean | null
hook_custom_access_token_secrets: string | null
hook_custom_access_token_uri: string | null
hook_mfa_verification_attempt_enabled: boolean | null
hook_mfa_verification_attempt_secrets: string | null
hook_mfa_verification_attempt_uri: string | null
hook_password_verification_attempt_enabled: boolean | null
hook_password_verification_attempt_secrets: string | null
hook_password_verification_attempt_uri: string | null
hook_send_email_enabled: boolean | null
hook_send_email_secrets: string | null
hook_send_email_uri: string | null
hook_send_sms_enabled: boolean | null
hook_send_sms_secrets: string | null
hook_send_sms_uri: string | null
jwt_exp: number | null
mailer_allow_unverified_email_sign_ins: boolean | null
mailer_autoconfirm: boolean | null
mailer_notifications_email_changed_enabled: boolean | null
mailer_notifications_identity_linked_enabled: boolean | null
mailer_notifications_identity_unlinked_enabled: boolean | null
mailer_notifications_mfa_factor_enrolled_enabled: boolean | null
mailer_notifications_mfa_factor_unenrolled_enabled: boolean | null
mailer_notifications_password_changed_enabled: boolean | null
mailer_notifications_phone_changed_enabled: boolean | null
mailer_otp_exp: number
mailer_otp_length: number | null
mailer_secure_email_change_enabled: boolean | null
mailer_subjects_confirmation: string | null
mailer_subjects_email_change: string | null
mailer_subjects_email_changed_notification: string | null
mailer_subjects_identity_linked_notification: string | null
mailer_subjects_identity_unlinked_notification: string | null
mailer_subjects_invite: string | null
mailer_subjects_magic_link: string | null
mailer_subjects_mfa_factor_enrolled_notification: string | null
mailer_subjects_mfa_factor_unenrolled_notification: string | null
mailer_subjects_password_changed_notification: string | null
mailer_subjects_phone_changed_notification: string | null
mailer_subjects_reauthentication: string | null
mailer_subjects_recovery: string | null
mailer_templates_confirmation_content: string | null
mailer_templates_email_change_content: string | null
mailer_templates_email_changed_notification_content: string | null
mailer_templates_identity_linked_notification_content: string | null
mailer_templates_identity_unlinked_notification_content: string | null
mailer_templates_invite_content: string | null
mailer_templates_magic_link_content: string | null
mailer_templates_mfa_factor_enrolled_notification_content: string | null
mailer_templates_mfa_factor_unenrolled_notification_content: string | null
mailer_templates_password_changed_notification_content: string | null
mailer_templates_phone_changed_notification_content: string | null
mailer_templates_reauthentication_content: string | null
mailer_templates_recovery_content: string | null
mfa_max_enrolled_factors: number | null
mfa_phone_enroll_enabled: boolean | null
mfa_phone_max_frequency: number | null
mfa_phone_otp_length: number
mfa_phone_template: string | null
mfa_phone_verify_enabled: boolean | null
mfa_totp_enroll_enabled: boolean | null
mfa_totp_verify_enabled: boolean | null
mfa_web_authn_enroll_enabled: boolean | null
mfa_web_authn_verify_enabled: boolean | null
nimbus_oauth_client_id: string | null
nimbus_oauth_client_secret: string | null
nimbus_oauth_email_optional: boolean | null
oauth_server_allow_dynamic_registration: boolean
oauth_server_authorization_path: string | null
oauth_server_enabled: boolean
passkey_enabled: boolean
password_hibp_enabled: boolean | null
password_min_length: number | null
/** @enum {string|null} */
password_required_characters:
| 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789'
| 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789'
| 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789:!@#$%^&*()_+-=[]{};\'\\\\:"|<>?,./`~'
| ''
| null
rate_limit_anonymous_users: number | null
rate_limit_email_sent: number | null
rate_limit_otp: number | null
rate_limit_sms_sent: number | null
rate_limit_token_refresh: number | null
rate_limit_verify: number | null
rate_limit_web3: number | null
refresh_token_rotation_enabled: boolean | null
saml_allow_encrypted_assertions: boolean | null
saml_enabled: boolean | null
saml_external_url: string | null
security_captcha_enabled: boolean | null
/** @enum {string|null} */
security_captcha_provider: 'turnstile' | 'hcaptcha' | null
security_captcha_secret: string | null
security_manual_linking_enabled: boolean | null
security_refresh_token_reuse_interval: number | null
security_sb_forwarded_for_enabled: boolean | null
security_update_password_require_current_password: boolean | null
security_update_password_require_reauthentication: boolean | null
sessions_inactivity_timeout: number | null
sessions_single_per_user: boolean | null
sessions_tags: string | null
sessions_timebox: number | null
site_url: string | null
sms_autoconfirm: boolean | null
sms_max_frequency: number | null
sms_messagebird_access_key: string | null
sms_messagebird_originator: string | null
sms_otp_exp: number | null
sms_otp_length: number
/** @enum {string|null} */
sms_provider: 'messagebird' | 'textlocal' | 'twilio' | 'twilio_verify' | 'vonage' | null
sms_template: string | null
sms_test_otp: string | null
/** Format: date-time */
sms_test_otp_valid_until: string | null
sms_textlocal_api_key: string | null
sms_textlocal_sender: string | null
sms_twilio_account_sid: string | null
sms_twilio_auth_token: string | null
sms_twilio_content_sid: string | null
sms_twilio_message_service_sid: string | null
sms_twilio_verify_account_sid: string | null
sms_twilio_verify_auth_token: string | null
sms_twilio_verify_message_service_sid: string | null
sms_vonage_api_key: string | null
sms_vonage_api_secret: string | null
sms_vonage_from: string | null
/** Format: email */
smtp_admin_email: string | null
smtp_host: string | null
smtp_max_frequency: number | null
smtp_pass: string | null
smtp_port: string | null
smtp_sender_name: string | null
smtp_user: string | null
uri_allow_list: string | null
webauthn_rp_display_name: string | null
webauthn_rp_id: string | null
webauthn_rp_origins: string | null
}
/** @example {
* "role": "postgres",
* "rhost": "203.0.113.10"
* } */
AuthorizeJitAccessBody: {
rhost: string
role: string
}
/** @example {
* "migration_version": "20250312000000"
* } */
BranchActionBody: {
migration_version?: string
}
BranchDeleteResponse_Output: {
/** @enum {string} */
message: 'ok'
}
BranchDetailResponse_Output: {
db_host: string
db_pass?: string
db_port: number
db_user?: string
jwt_secret?: string
postgres_engine: string
postgres_version: string
ref: string
release_channel: string
/** @enum {string} */
status:
| 'INACTIVE'
| 'ACTIVE_HEALTHY'
| 'ACTIVE_UNHEALTHY'
| 'COMING_UP'
| 'UNKNOWN'
| 'GOING_DOWN'
| 'INIT_FAILED'
| 'REMOVED'
| 'RESTORING'
| 'UPGRADING'
| 'PAUSING'
| 'RESTORE_FAILED'
| 'RESTARTING'
| 'PAUSE_FAILED'
| 'RESIZING'
}
BranchResponse_Output: {
/** Format: date-time */
created_at: string
/** Format: date-time */
deletion_scheduled_at?: string
git_branch?: string
/** Format: uuid */
id: string
is_default: boolean
/**
* @deprecated
* @description This field is deprecated and will not be populated.
*/
latest_check_run_id?: number
name: string
/** Format: uri */
notify_url?: string
parent_project_ref: string
persistent: boolean
/** Format: int32 */
pr_number?: number
/** @enum {string} */
preview_project_status?:
| 'INACTIVE'
| 'ACTIVE_HEALTHY'
| 'ACTIVE_UNHEALTHY'
| 'COMING_UP'
| 'UNKNOWN'
| 'GOING_DOWN'
| 'INIT_FAILED'
| 'REMOVED'
| 'RESTORING'
| 'UPGRADING'
| 'PAUSING'
| 'RESTORE_FAILED'
| 'RESTARTING'
| 'PAUSE_FAILED'
| 'RESIZING'
project_ref: string
/** Format: date-time */
review_requested_at?: string
/**
* @deprecated
* @description This field is deprecated. List action runs to get branch status instead.
* @enum {string}
*/
status:
| 'CREATING_PROJECT'
| 'RUNNING_MIGRATIONS'
| 'MIGRATIONS_PASSED'
| 'MIGRATIONS_FAILED'
| 'FUNCTIONS_DEPLOYED'
| 'FUNCTIONS_FAILED'
/** Format: date-time */
updated_at: string
with_data: boolean
}
BranchRestoreResponse_Output: {
/** @enum {string} */
message: 'Branch restoration initiated'
}
BranchUpdateResponse_Output: {
/** @enum {string} */
message: 'ok'
workflow_run_id: string
}
/** @example [
* {
* "id": "3c078cce-ad70-4148-9f37-4da362789053",
* "slug": "hello-world",
* "name": "Hello World",
* "status": "ACTIVE",
* "version": 2,
* "verify_jwt": true,
* "entrypoint_path": "index.ts"
* }
* ] */
BulkUpdateFunctionBody: {
/** Format: int64 */
created_at?: number
entrypoint_path?: string
ezbr_sha256?: string
id: string
import_map?: boolean
import_map_path?: string
name: string
slug: string
/** @enum {string} */
status: 'ACTIVE' | 'REMOVED' | 'THROTTLED'
verify_jwt?: boolean
version: number
}[]
BulkUpdateFunctionResponse_Output: {
functions: {
/** Format: int64 */
created_at: number
entrypoint_path?: string
ezbr_sha256?: string
id: string
import_map?: boolean
import_map_path?: string
name: string
slug: string
/** @enum {string} */
status: 'ACTIVE' | 'REMOVED' | 'THROTTLED'
/** Format: int64 */
updated_at: number
verify_jwt?: boolean
version: number
}[]
}
/** @example {
* "type": "secret",
* "name": "ci_secret_key",
* "description": "CI deploy key"
* } */
CreateApiKeyBody: {
description?: string | null
name: string
secret_jwt_template?: {
[key: string]: unknown
} | null
/** @enum {string} */
type: 'publishable' | 'secret'
}
/** @example {
* "branch_name": "preview-login-page",
* "git_branch": "feature/login-page",
* "persistent": true,
* "with_data": false,
* "notify_url": "https://example.com/webhooks/branches"
* } */
CreateBranchBody: {
branch_name: string
/** @enum {string} */
desired_instance_size?:
| 'pico'
| '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'
git_branch?: string
is_default?: boolean
/**
* Format: uri
* @description HTTP endpoint to receive branch status updates.
*/
notify_url?: string
persistent?: boolean
/**
* @description Postgres engine version. If not provided, the latest version will be used.
* @enum {string}
*/
postgres_engine?: '15' | '17' | '17-oriole'
region?: string
/**
* @description Release channel. If not provided, GA will be used.
* @enum {string}
*/
release_channel?: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
secrets?: {
[key: string]: string
}
with_data?: boolean
}
/** @example {
* "name": "Acme"
* } */
CreateOrganizationV1: {
name: string
}
CreateProjectClaimTokenResponse_Output: {
created_at: string
/** Format: uuid */
created_by: string
expires_at: string
token: string
token_alias: string
}
/** @example {
* "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"
* }
* }
* }
* } */
CreateProviderBody: {
attribute_mapping?: {
keys: {
[key: string]: {
array?: boolean
default?: Record<string, never> | number | string | boolean
name?: string
names?: string[]
}
}
}
domains?: string[]
metadata_url?: string
metadata_xml?: string
/** @enum {string} */
name_id_format?:
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
/**
* @description What type of provider will be created
* @enum {string}
*/
type: 'saml'
}
CreateProviderResponse_Output: {
created_at?: string
domains?: {
created_at?: string
domain?: string
updated_at?: string
}[]
id: string
saml?: {
attribute_mapping?: {
keys: {
[key: string]: {
array?: boolean
default?: Record<string, never> | number | string | boolean
name?: string
names?: string[]
}
}
}
entity_id: string
metadata_url?: string
metadata_xml?: string
/** @enum {string} */
name_id_format?:
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
}
updated_at?: string
}
/** @example {
* "read_only": true
* } */
CreateRoleBody: {
read_only: boolean
}
CreateRoleResponse_Output: {
password: string
role: string
/** Format: int64 */
ttl_seconds: number
}
/** @example [
* {
* "name": "OPENAI_API_KEY",
* "value": "sk-example-secret"
* },
* {
* "name": "STRIPE_WEBHOOK_SECRET",
* "value": "whsec_example"
* }
* ] */
CreateSecretBody: {
/** @description Secret name must not start with the SUPABASE_ prefix. */
name: string
value: string
}[]
/** @example {
* "algorithm": "RS256",
* "status": "standby"
* } */
CreateSigningKeyBody: {
/** @enum {string} */
algorithm: 'EdDSA' | 'ES256' | 'RS256' | 'HS256'
private_jwk?:
| {
/** @enum {string} */
alg?: 'RS256'
d: string
dp: string
dq: string
/** @enum {string} */
e: 'AQAB'
/** @enum {boolean} */
ext?: true
key_ops?: ('sign' | 'verify')[]
/** Format: uuid */
kid?: string
/** @enum {string} */
kty: 'RSA'
n: string
p: string
q: string
qi: string
/** @enum {string} */
use?: 'sig'
}
| {
/** @enum {string} */
alg?: 'ES256'
/** @enum {string} */
crv: 'P-256'
d: string
/** @enum {boolean} */
ext?: true
key_ops?: ('sign' | 'verify')[]
/** Format: uuid */
kid?: string
/** @enum {string} */
kty: 'EC'
/** @enum {string} */
use?: 'sig'
x: string
y: string
}
| {
/** @enum {string} */
alg?: 'EdDSA'
/** @enum {string} */
crv: 'Ed25519'
d: string
/** @enum {boolean} */
ext?: true
key_ops?: ('sign' | 'verify')[]
/** Format: uuid */
kid?: string
/** @enum {string} */
kty: 'OKP'
/** @enum {string} */
use?: 'sig'
x: string
}
| {
/** @enum {string} */
alg?: 'HS256'
/** @enum {boolean} */
ext?: true
k: string
key_ops?: ('sign' | 'verify')[]
/** Format: uuid */
kid?: string
/** @enum {string} */
kty: 'oct'
/** @enum {string} */
use?: 'sig'
}
/** @enum {string} */
status?: 'in_use' | 'standby'
}
/** @example {
* "oidc_issuer_url": "https://login.acme.com",
* "jwks_url": "https://login.acme.com/.well-known/jwks.json"
* } */
CreateThirdPartyAuthBody: {
custom_jwks?: unknown
jwks_url?: string
oidc_issuer_url?: string
}
DatabaseUpgradeStatusResponse_Output: {
databaseUpgradeStatus: {
/** @enum {string} */
error?:
| '1_upgraded_instance_launch_failed'
| '2_volume_detachchment_from_upgraded_instance_failed'
| '3_volume_attachment_to_original_instance_failed'
| '4_data_upgrade_initiation_failed'
| '5_data_upgrade_completion_failed'
| '6_volume_detachchment_from_original_instance_failed'
| '7_volume_attachment_to_upgraded_instance_failed'
| '8_upgrade_completion_failed'
| '9_post_physical_backup_failed'
initiated_at: string
latest_status_at: string
/** @enum {string} */
progress?:
| '0_requested'
| '1_started'
| '2_launched_upgraded_instance'
| '3_detached_volume_from_upgraded_instance'
| '4_attached_volume_to_original_instance'
| '5_initiated_data_upgrade'
| '6_completed_data_upgrade'
| '7_detached_volume_from_original_instance'
| '8_attached_volume_to_upgraded_instance'
| '9_completed_upgrade'
| '10_completed_post_physical_backup'
status: number
target_version: string
} | null
}
DeleteProviderResponse_Output: {
created_at?: string
domains?: {
created_at?: string
domain?: string
updated_at?: string
}[]
id: string
saml?: {
attribute_mapping?: {
keys: {
[key: string]: {
array?: boolean
default?: Record<string, never> | number | string | boolean
name?: string
names?: string[]
}
}
}
entity_id: string
metadata_url?: string
metadata_xml?: string
/** @enum {string} */
name_id_format?:
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
}
updated_at?: string
}
DeleteRolesResponse_Output: {
/** @enum {string} */
message: 'ok'
}
/** @example [
* "OPENAI_API_KEY"
* ] */
DeleteSecretsBody: string[]
DeployFunctionResponse_Output: {
/** Format: int64 */
created_at?: number
entrypoint_path?: string
ezbr_sha256?: string
id: string
import_map?: boolean
import_map_path?: string
name: string
slug: string
/** @enum {string} */
status: 'ACTIVE' | 'REMOVED' | 'THROTTLED'
/** Format: int64 */
updated_at?: number
verify_jwt?: boolean
version: number
}
DiskAutoscaleConfig_Output: {
/** @description Growth percentage for disk autoscaling */
growth_percent: number | null
/** @description Maximum limit the disk size will grow to in GB */
max_size_gb: number | null
/** @description Minimum increment size for disk autoscaling in GB */
min_increment_gb: number | null
}
/** @example {
* "attributes": {
* "type": "gp3",
* "size_gb": 100,
* "iops": 3000,
* "throughput_mibps": 125
* }
* } */
DiskRequestBody: {
attributes:
| {
iops: number
size_gb: number
throughput_mibps?: number
/** @enum {string} */
type: 'gp3'
}
| {
iops: number
size_gb: number
/** @enum {string} */
type: 'io2'
}
}
DiskResponse_Output: {
attributes:
| {
iops: number
size_gb: number
throughput_mibps?: number
/** @enum {string} */
type: 'gp3'
}
| {
iops: number
size_gb: number
/** @enum {string} */
type: 'io2'
}
last_modified_at?: string
}
DiskUtilMetricsResponse_Output: {
metrics: {
fs_avail_bytes: number
fs_size_bytes: number
fs_used_bytes: number
}
timestamp: string
}
/** @example {
* "file": [
* "./supabase/functions/hello-world/index.ts"
* ],
* "metadata": {
* "entrypoint_path": "index.ts",
* "verify_jwt": true,
* "name": "Hello World"
* }
* } */
FunctionDeployBody: {
file: string[]
metadata: {
entrypoint_path: string
import_map_path?: string
name?: string
static_patterns?: string[]
verify_jwt?: boolean
}
}
FunctionResponse_Output: {
/** Format: int64 */
created_at: number
entrypoint_path?: string
ezbr_sha256?: string
id: string
import_map?: boolean
import_map_path?: string
name: string
slug: string
/** @enum {string} */
status: 'ACTIVE' | 'REMOVED' | 'THROTTLED'
/** Format: int64 */
updated_at: number
verify_jwt?: boolean
version: number
}
FunctionSlugResponse_Output: {
/** Format: int64 */
created_at: number
entrypoint_path?: string
ezbr_sha256?: string
id: string
import_map?: boolean
import_map_path?: string
name: string
slug: string
/** @enum {string} */
status: 'ACTIVE' | 'REMOVED' | 'THROTTLED'
/** Format: int64 */
updated_at: number
verify_jwt?: boolean
version: number
}
GetProjectAvailableRestoreVersionsResponse_Output: {
available_versions: {
/** @enum {string} */
postgres_engine: '13' | '14' | '15' | '17' | '17-oriole'
/** @enum {string} */
release_channel: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
version: string
}[]
}
GetProjectDbMetadataResponse_Output: {
databases: {
name: string
schemas: {
name: string
}[]
}[]
}
GetProviderResponse_Output: {
created_at?: string
domains?: {
created_at?: string
domain?: string
updated_at?: string
}[]
id: string
saml?: {
attribute_mapping?: {
keys: {
[key: string]: {
array?: boolean
default?: Record<string, never> | number | string | boolean
name?: string
names?: string[]
}
}
}
entity_id: string
metadata_url?: string
metadata_xml?: string
/** @enum {string} */
name_id_format?:
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
}
updated_at?: string
}
/** @example {
* "email": "[email protected]",
* "roles": [
* {
* "role": "postgres",
* "expires_at": 1740787200,
* "allowed_networks": {
* "allowed_cidrs": [
* {
* "cidr": "203.0.113.0/24"
* }
* ]
* },
* "branches_only": false
* }
* ]
* } */
InviteExternalUserJitAccessBody: {
/** Format: email */
email: string
roles: {
allowed_networks?: {
allowed_cidrs?: {
/** Format: cidrv4 */
cidr: string
}[]
allowed_cidrs_v6?: {
/** Format: cidrv6 */
cidr: string
}[]
}
branches_only?: boolean
expires_at?: number
role: string
}[]
}
InviteExternalUserJitResponse_Output: {
/** Format: email */
email: string
/** Format: uuid */
invite_id: string
user_roles: {
allowed_networks?: {
allowed_cidrs?: {
/** Format: cidrv4 */
cidr: string
}[]
allowed_cidrs_v6?: {
/** Format: cidrv6 */
cidr: string
}[]
}
branches_only?: boolean
expires_at?: number
role: string
}[]
}
/** @example {
* "state": "enabled"
* } */
JitAccessRequestRequest: {
/** @enum {string} */
state: 'enabled' | 'disabled'
}
JitAccessResponse_Output: {
/** Format: uuid */
user_id?: string
user_roles: {
allowed_networks?: {
allowed_cidrs?: {
/** Format: cidrv4 */
cidr: string
}[]
allowed_cidrs_v6?: {
/** Format: cidrv6 */
cidr: string
}[]
}
branches_only?: boolean
expires_at?: number
role: string
}[]
}
JitAuthorizeAccessResponse_Output: {
act?: string
/** Format: uuid */
user_id?: string
user_role: {
allowed_networks?: {
allowed_cidrs?: {
/** Format: cidrv4 */
cidr: string
}[]
allowed_cidrs_v6?: {
/** Format: cidrv6 */
cidr: string
}[]
}
branches_only?: boolean
expires_at?: number
role: string
}
}
JitListAccessResponse_Output: {
items: (
| {
expires_at: null
invite_id: null
primary_email: string | null
/** Format: uuid */
user_id: string
user_roles: {
allowed_networks?: {
allowed_cidrs?: {
/** Format: cidrv4 */
cidr: string
}[]
allowed_cidrs_v6?: {
/** Format: cidrv6 */
cidr: string
}[]
}
branches_only?: boolean
expires_at?: number
role: string
}[]
}
| {
expires_at: string
/** Format: uuid */
invite_id: string
primary_email: string
user_id: null
user_roles: {
allowed_networks?: {
allowed_cidrs?: {
/** Format: cidrv4 */
cidr: string
}[]
allowed_cidrs_v6?: {
/** Format: cidrv6 */
cidr: string
}[]
}
branches_only?: boolean
expires_at?: number
role: string
}[]
}
)[]
}
/** @description Any JSON-serializable value */
JsonValue_Output:
| ((string | number | boolean) | null)
| components['schemas']['JsonValue_Output'][]
| {
[key: string]: components['schemas']['JsonValue_Output']
}
LegacyApiKeysResponse_Output: {
enabled: boolean
}
ListActionRunResponse_Output: {
branch_id: string
check_run_id: number | null
created_at: string
git_config?: unknown
id: string
run_steps: {
created_at: string
/** @enum {string} */
name: 'clone' | 'pull' | 'health' | 'configure' | 'migrate' | 'seed' | 'deploy'
/** @enum {string} */
status: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
updated_at: string
}[]
updated_at: string
workdir: string | null
}[]
ListProjectAddonsResponse_Output: {
available_addons: {
name: string
/** @enum {string} */
type:
| 'custom_domain'
| 'compute_instance'
| 'pitr'
| 'ipv4'
| 'auth_mfa_phone'
| 'auth_mfa_web_authn'
| 'log_drain'
| 'etl_pipeline'
variants: {
id:
| (
| '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'
)
| 'cd_default'
| ('pitr_7' | 'pitr_14' | 'pitr_28')
| 'ipv4_default'
| 'auth_mfa_phone_default'
| 'auth_mfa_web_authn_default'
| 'log_drain_default'
| 'etl_pipeline_default'
meta?: components['schemas']['JsonValue_Output']
name: string
price: {
amount: number
description: string
/** @enum {string} */
interval: 'monthly' | 'hourly'
/** @enum {string} */
type: 'fixed' | 'usage'
}
}[]
}[]
selected_addons: {
/** @enum {string} */
type:
| 'custom_domain'
| 'compute_instance'
| 'pitr'
| 'ipv4'
| 'auth_mfa_phone'
| 'auth_mfa_web_authn'
| 'log_drain'
| 'etl_pipeline'
variant: {
id:
| (
| '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'
)
| 'cd_default'
| ('pitr_7' | 'pitr_14' | 'pitr_28')
| 'ipv4_default'
| 'auth_mfa_phone_default'
| 'auth_mfa_web_authn_default'
| 'log_drain_default'
| 'etl_pipeline_default'
meta?: components['schemas']['JsonValue_Output']
name: string
price: {
amount: number
description: string
/** @enum {string} */
interval: 'monthly' | 'hourly'
/** @enum {string} */
type: 'fixed' | 'usage'
}
}
}[]
}
ListProvidersResponse_Output: {
items: {
created_at?: string
domains?: {
created_at?: string
domain?: string
updated_at?: string
}[]
id: string
saml?: {
attribute_mapping?: {
keys: {
[key: string]: {
array?: boolean
default?: Record<string, never> | number | string | boolean
name?: string
names?: string[]
}
}
}
entity_id: string
metadata_url?: string
metadata_xml?: string
/** @enum {string} */
name_id_format?:
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
}
updated_at?: string
}[]
}
NetworkBanResponse_Output: {
banned_ipv4_addresses: string[]
}
NetworkBanResponseEnriched_Output: {
banned_ipv4_addresses: {
banned_address: string
identifier: string
type: string
}[]
}
/** @example {
* "add": {
* "dbAllowedCidrs": [
* "203.0.113.0/24"
* ]
* },
* "remove": {
* "dbAllowedCidrs": [
* "198.51.100.0/24"
* ]
* }
* } */
NetworkRestrictionsPatchRequest: {
add?: {
dbAllowedCidrs?: string[]
dbAllowedCidrsV6?: string[]
}
remove?: {
dbAllowedCidrs?: string[]
dbAllowedCidrsV6?: string[]
}
}
/** @example {
* "dbAllowedCidrs": [
* "203.0.113.0/24"
* ],
* "dbAllowedCidrsV6": [
* "2001:db8::/32"
* ]
* } */
NetworkRestrictionsRequest: {
dbAllowedCidrs?: string[]
dbAllowedCidrsV6?: string[]
}
NetworkRestrictionsResponse_Output: {
/** Format: date-time */
applied_at?: string
/**
* @description At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`.
* @example {
* "dbAllowedCidrs": [
* "203.0.113.0/24"
* ],
* "dbAllowedCidrsV6": [
* "2001:db8::/32"
* ]
* }
*/
config: {
dbAllowedCidrs?: string[]
dbAllowedCidrsV6?: string[]
}
/** @enum {string} */
entitlement: 'disallowed' | 'allowed'
/**
* @description Populated when a new config has been received, but not registered as successfully applied to a project.
* @example {
* "dbAllowedCidrs": [
* "203.0.113.0/24"
* ],
* "dbAllowedCidrsV6": [
* "2001:db8::/32"
* ]
* }
*/
old_config?: {
dbAllowedCidrs?: string[]
dbAllowedCidrsV6?: string[]
}
/** @enum {string} */
status: 'stored' | 'applied'
/** Format: date-time */
updated_at?: string
}
NetworkRestrictionsV2Response_Output: {
/** Format: date-time */
applied_at?: string
/** @description At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`. */
config: {
dbAllowedCidrs?: {
address: string
/** @enum {string} */
type: 'v4' | 'v6'
}[]
}
/** @enum {string} */
entitlement: 'disallowed' | 'allowed'
/** @description Populated when a new config has been received, but not registered as successfully applied to a project. */
old_config?: {
dbAllowedCidrs?: {
address: string
/** @enum {string} */
type: 'v4' | 'v6'
}[]
}
/** @enum {string} */
status: 'stored' | 'applied'
/** Format: date-time */
updated_at?: string
}
/** @example {
* "client_id": "66666666-6666-4666-8666-666666666666",
* "client_secret": "sb_secret_live_example_9f4d3a206b2e4a7e8c91",
* "refresh_token": "oauth_refresh_9f4d3a206b2e4a7e8c91"
* } */
OAuthRevokeTokenBody: {
/** Format: uuid */
client_id: string
client_secret: string
refresh_token: string
}
/** @example {
* "grant_type": "authorization_code",
* "client_id": "66666666-6666-4666-8666-666666666666",
* "client_secret": "sb_secret_live_example_9f4d3a206b2e4a7e8c91",
* "code": "oauth_code_9f4d3a206b2e4a7e8c91",
* "code_verifier": "qW0Z6d9pQnW0mL1dK1q9wFq6Yz2nV5rA8jT3mP7sH4c",
* "redirect_uri": "https://app.acme.com/auth/callback",
* "scope": "projects:read projects:write"
* } */
OAuthTokenBody: {
/** @description IDJAG assertion JWT for grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer. Beta - available on Team and Enterprise plans only. */
assertion?: string
/** Format: uuid */
client_id?: string
client_secret?: string
code?: string
code_verifier?: string
/** @enum {string} */
grant_type?:
| 'authorization_code'
| 'refresh_token'
| 'urn:ietf:params:oauth:grant-type:jwt-bearer'
redirect_uri?: string
refresh_token?: string
/**
* Format: uri
* @description Resource indicator for MCP (Model Context Protocol) clients
*/
resource?: string
scope?: string
}
OAuthTokenResponse_Output: {
access_token: string
expires_in: number
/** @description The `urn:ietf:params:oauth:grant-type:jwt-bearer` grant type issues access tokens only, no refresh token is returned and the token cannot be revoked via `/v1/oauth/revoke`. */
refresh_token?: string
/** @enum {string} */
token_type: 'Bearer'
}
OrganizationProjectClaimResponse_Output: {
created_at: string
/** Format: uuid */
created_by: string
expires_at: string
preview: {
errors: {
key: string
message: string
}[]
info: {
key: string
message: string
}[]
members_exceeding_free_project_limit: {
limit: number
name: string
}[]
/** @enum {string} */
source_subscription_plan: 'free' | 'pro' | 'team' | 'enterprise' | 'platform'
/** @enum {string|null} */
target_subscription_plan: 'free' | 'pro' | 'team' | 'enterprise' | 'platform' | null
valid: boolean
warnings: {
key: string
message: string
}[]
}
project: {
name: string
ref: string
}
}
OrganizationProjectsResponse_Output: {
pagination: {
/** @description Total number of projects. Use this to calculate the total number of pages. */
count: number
/** @description Maximum number of projects per page */
limit: number
/** @description Number of projects skipped in this response */
offset: number
}
projects: {
cloud_provider: string
databases: {
cloud_provider: string
disk_last_modified_at?: string
disk_throughput_mbps?: number
/** @enum {string} */
disk_type?: 'gp3' | 'io2'
disk_volume_size_gb?: number
identifier: string
/** @enum {string} */
infra_compute_size?:
| 'pico'
| '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'
region: string
/** @enum {string} */
status:
| 'ACTIVE_HEALTHY'
| 'ACTIVE_UNHEALTHY'
| 'COMING_UP'
| 'GOING_DOWN'
| 'INIT_FAILED'
| 'REMOVED'
| 'RESTORING'
| 'UNKNOWN'
| 'INIT_READ_REPLICA'
| 'INIT_READ_REPLICA_FAILED'
| 'RESTARTING'
| 'RESIZING'
/** @enum {string} */
type: 'PRIMARY' | 'READ_REPLICA'
}[]
inserted_at: string
is_branch: boolean
name: string
ref: string
region: string
/** @enum {string} */
status:
| 'INACTIVE'
| 'ACTIVE_HEALTHY'
| 'ACTIVE_UNHEALTHY'
| 'COMING_UP'
| 'UNKNOWN'
| 'GOING_DOWN'
| 'INIT_FAILED'
| 'REMOVED'
| 'RESTORING'
| 'UPGRADING'
| 'PAUSING'
| 'RESTORE_FAILED'
| 'RESTARTING'
| 'PAUSE_FAILED'
| 'RESIZING'
}[]
}
OrganizationResponseV1_Output: {
/**
* @deprecated
* @description Deprecated: Use `slug` instead.
*/
id: string
name: string
/**
* @description Organization slug
* @example tsrqponmlkjihgfedcba
*/
slug: string
}
/** @example {
* "root_key": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
* } */
PgsodiumConfigResponse_Output: {
/** @description The pgsodium root key: 32 bytes, hex-encoded (64 characters). */
root_key: string
}
PlanGateErrorBody: {
/** @description Present on entitlement denials. Other errors with this status code (validation, billing state) carry only message. */
error?: {
/**
* @description Machine-readable marker for plan-gated denials
* @enum {string}
*/
code: 'entitlement_required'
/** @description Entitlement feature key that failed the check */
feature: string
/** @description Billing page URL for the organization, present when the org is resolvable */
upgrade_url?: string
}
/** @description Human-readable explanation of the plan gate */
message: string
}
PostgresConfigResponse_Output: {
autovacuum_max_workers?: number
autovacuum_work_mem?: string
/** @description Default unit: s */
checkpoint_timeout?: string
'cron.log_statement'?: boolean
effective_cache_size?: string
hot_standby_feedback?: boolean
/** @description Default unit: ms */
log_autovacuum_min_duration?: string
log_checkpoints?: boolean
log_connections?: boolean
log_disconnections?: boolean
log_duration?: boolean
log_lock_waits?: boolean
log_recovery_conflict_waits?: boolean
log_replication_commands?: boolean
/** @description Default unit: ms */
log_startup_progress_interval?: string
log_temp_files?: string
logical_decoding_work_mem?: string
maintenance_work_mem?: string
max_connections?: number
max_locks_per_transaction?: number
max_logical_replication_workers?: number
max_parallel_maintenance_workers?: number
max_parallel_workers?: number
max_parallel_workers_per_gather?: number
max_replication_slots?: number
max_slot_wal_keep_size?: string
max_standby_archive_delay?: string
max_standby_streaming_delay?: string
max_sync_workers_per_subscription?: number
max_wal_senders?: number
max_wal_size?: string
max_worker_processes?: number
'pg_net.batch_size'?: number
'pg_stat_statements.max'?: number
/** @enum {string} */
session_replication_role?: 'origin' | 'replica' | 'local'
shared_buffers?: string
/** @description Default unit: ms */
statement_timeout?: string
track_activity_query_size?: string
track_commit_timestamp?: boolean
wal_keep_size?: string
/** @description Default unit: ms */
wal_sender_timeout?: string
work_mem?: string
}
PostgrestConfigWithJWTSecretResponse_Output: {
db_extra_search_path: string
/** @description If `null`, the value is automatically configured based on compute size. */
db_pool: number | null
/** @description If `null`, the value is automatically configured to 10. */
db_pool_acquisition_timeout: number | null
db_schema: string
jwt_secret?: string
max_rows: number
}
ProjectClaimTokenResponse_Output: {
created_at: string
/** Format: uuid */
created_by: string
expires_at: string
token_alias: string
}
ProjectUpgradeEligibilityResponse_Output: {
current_app_version: string
/** @enum {string} */
current_app_version_release_channel:
| 'internal'
| 'alpha'
| 'beta'
| 'ga'
| 'withdrawn'
| 'preview'
duration_estimate_hours: number
eligible: boolean
latest_app_version: string
legacy_auth_custom_roles: string[]
/**
* @deprecated
* @description Use validation_errors instead.
*/
objects_to_be_dropped: string[]
target_upgrade_versions: {
app_version: string
/** @enum {string} */
postgres_version: '13' | '14' | '15' | '17' | '17-oriole'
/** @enum {string} */
release_channel: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
}[]
/**
* @deprecated
* @description Use validation_errors instead.
*/
unsupported_extensions: string[]
/**
* @deprecated
* @description Use validation_errors instead.
*/
user_defined_objects_in_internal_schemas: string[]
validation_errors: (
| {
dependents: string[]
/** @enum {string} */
type: 'objects_depending_on_pg_cron'
}
| {
index_name: string
schema_name: string
table_name: string
/** @enum {string} */
type: 'indexes_referencing_ll_to_earth'
}
| {
function_name: string
lang_name: string
schema_name: string
/** @enum {string} */
type: 'function_using_obsolete_lang'
}
| {
extension_name: string
/** @enum {string} */
type: 'unsupported_extension'
}
| {
fdw_handler_name: string
fdw_name: string
/** @enum {string} */
type: 'unsupported_fdw_handler'
}
| {
schema_name: string
sequence_name: string
table_name: string
/** @enum {string} */
type: 'unlogged_table_with_persistent_sequence'
}
| {
obj_name: string
obj_type: 'table' | 'function'
schema_name: string
/** @enum {string} */
type: 'user_defined_objects_in_internal_schemas'
}
| {
slot_name: string
/** @enum {string} */
type: 'active_replication_slot'
}
| {
/** @enum {string} */
type: 'x86_architecture'
}
| {
/** @enum {string} */
type: 'project_hibernating'
}
)[]
warnings: (
| {
/** @enum {string} */
type: 'pg_graphql_introspection_change'
}
| {
/** @enum {string} */
type: 'ltree_reindex_required'
}
| {
/** @enum {string} */
type: 'operator_estimator_gate'
}
| {
/** @enum {string} */
type: 'btree_gist_nan_reindex'
}
)[]
}
ProjectUpgradeInitiateResponse_Output: {
tracking_id: string
}
ReadOnlyStatusResponse_Output: {
enabled: boolean
override_active_until: string
override_enabled: boolean
}
RealtimeConfigResponse_Output: {
/**
* Format: date-time
* @description If set, the Realtime service has been suspended by an admin.
*/
admin_suspended_at: string | null
/** @description Sets connection pool size for Realtime Authorization */
connection_pool: number | null
/** @description Sets maximum number of bytes per second rate per channel limit */
max_bytes_per_second: number | null
/** @description Sets maximum number of channels per client rate limit */
max_channels_per_client: number | null
/** @description Sets maximum number of concurrent users rate limit */
max_concurrent_users: number | null
/** @description Sets maximum number of events per second rate per channel limit */
max_events_per_second: number | null
/** @description Sets maximum number of joins per second rate limit */
max_joins_per_second: number | null
/** @description Sets maximum number of payload size in KB rate limit */
max_payload_size_in_kb: number | null
/** @description Sets maximum number of presence events per second rate limit */
max_presence_events_per_second: number | null
/** @description Sets connection pool size used to create Postgres Changes subscriptions */
postgres_changes_pool: number | null
/** @description Whether to enable presence */
presence_enabled: boolean
/** @description Whether to only allow private channels */
private_only: boolean | null
/** @description Disables the Realtime service for this project when true. Set to false to re-enable it. */
suspend: boolean | null
}
RegionsInfoV1_Output: {
all: {
smartGroup: {
/** @enum {string} */
code: 'americas' | 'emea' | 'apac'
name: string
/** @enum {string} */
type: 'smartGroup'
}[]
specific: {
/** @enum {string} */
code:
| 'us-east-1'
| 'us-east-2'
| 'us-west-1'
| 'us-west-2'
| 'ap-southeast-1'
| 'ap-northeast-1'
| 'ap-northeast-2'
| 'ap-east-1'
| 'ap-southeast-2'
| 'eu-west-1'
| 'eu-west-2'
| 'eu-west-3'
| 'eu-north-1'
| 'eu-central-1'
| 'eu-central-2'
| 'ca-central-1'
| 'ap-south-1'
| 'sa-east-1'
name: string
/** @enum {string} */
provider: 'AWS' | 'AWS_K8S' | 'AWS_NIMBUS'
/** @enum {string} */
status?: 'capacity' | 'other'
/** @enum {string} */
type: 'specific'
}[]
}
recommendations: {
smartGroup: {
/** @enum {string} */
code: 'americas' | 'emea' | 'apac'
name: string
/** @enum {string} */
type: 'smartGroup'
}
specific: {
/** @enum {string} */
code:
| 'us-east-1'
| 'us-east-2'
| 'us-west-1'
| 'us-west-2'
| 'ap-southeast-1'
| 'ap-northeast-1'
| 'ap-northeast-2'
| 'ap-east-1'
| 'ap-southeast-2'
| 'eu-west-1'
| 'eu-west-2'
| 'eu-west-3'
| 'eu-north-1'
| 'eu-central-1'
| 'eu-central-2'
| 'ca-central-1'
| 'ap-south-1'
| 'sa-east-1'
name: string
/** @enum {string} */
provider: 'AWS' | 'AWS_K8S' | 'AWS_NIMBUS'
/** @enum {string} */
status?: 'capacity' | 'other'
/** @enum {string} */
type: 'specific'
}[]
}
}
/** @example {
* "ipv4_addresses": [
* "203.0.113.10"
* ],
* "requester_ip": false
* } */
RemoveNetworkBanRequest: {
identifier?: string
/** @description List of IP addresses to unban. */
ipv4_addresses: string[]
/**
* @description Include requester's public IP in the list of addresses to unban.
* @default false
*/
requester_ip?: boolean
}
/** @example {
* "database_identifier": "abcdefghijklmnopqrst-rr-us-west-1-abcde"
* } */
RemoveReadReplicaBody: {
database_identifier: string
}
SecretResponse_Output: {
name: string
updated_at?: string
value: string
}
/** @example {
* "read_replica_region": "us-west-1"
* } */
SetUpReadReplicaBody: {
/**
* @description Region you want your read replica to reside in
* @enum {string}
*/
read_replica_region:
| 'us-east-1'
| 'us-east-2'
| 'us-west-1'
| 'us-west-2'
| 'ap-east-1'
| 'ap-southeast-1'
| 'ap-northeast-1'
| 'ap-northeast-2'
| 'ap-southeast-2'
| 'eu-west-1'
| 'eu-west-2'
| 'eu-west-3'
| 'eu-north-1'
| 'eu-central-1'
| 'eu-central-2'
| 'ca-central-1'
| 'ap-south-1'
| 'sa-east-1'
}
SigningKeyResponse_Output: {
/** @enum {string} */
algorithm: 'EdDSA' | 'ES256' | 'RS256' | 'HS256'
/** Format: date-time */
created_at: string
/** Format: uuid */
id: string
public_jwk: unknown
/** @enum {string} */
status: 'in_use' | 'previously_used' | 'revoked' | 'standby'
/** Format: date-time */
updated_at: string
}
SigningKeysResponse_Output: {
keys: {
/** @enum {string} */
algorithm: 'EdDSA' | 'ES256' | 'RS256' | 'HS256'
/** Format: date-time */
created_at: string
/** Format: uuid */
id: string
public_jwk: unknown
/** @enum {string} */
status: 'in_use' | 'previously_used' | 'revoked' | 'standby'
/** Format: date-time */
updated_at: string
}[]
}
SnippetList_Output: {
cursor?: string
data: {
description: string | null
favorite: boolean
id: string
inserted_at: string
name: string
owner: {
id: number
username: string
}
project: {
id: number
name: string
}
/** @enum {string} */
type: 'sql'
updated_at: string
updated_by: {
id: number
username: string
}
/** @enum {string} */
visibility: 'user' | 'project' | 'org' | 'public'
}[]
}
SnippetResponse_Output: {
content: {
/**
* @deprecated
* @description Deprecated: Rely on root-level favorite property instead.
*/
favorite?: boolean
schema_version?: string
sql: string
}
description: string | null
favorite: boolean
id: string
inserted_at: string
name: string
owner: {
id: number
username: string
}
project: {
id: number
name: string
}
/** @enum {string} */
type: 'sql'
updated_at: string
updated_by: {
id: number
username: string
}
/** @enum {string} */
visibility: 'user' | 'project' | 'org' | 'public'
}
/** @example {
* "requestedConfig": {
* "database": true
* }
* } */
SslEnforcementRequest: {
requestedConfig: {
database: boolean
}
}
SslEnforcementResponse_Output: {
appliedSuccessfully: boolean
currentConfig: {
database: boolean
}
}
StorageConfigResponse_Output: {
capabilities: {
iceberg_catalog: boolean
list_v2: boolean
object_versioning: boolean
}
external: {
/** @enum {string} */
upstreamTarget: 'main' | 'canary'
}
features: {
icebergCatalog: {
enabled: boolean
maxCatalogs: number
maxNamespaces: number
maxTables: number
}
imageTransformation: {
enabled: boolean
}
purgeCache: {
enabled: boolean
}
s3Protocol: {
enabled: boolean
}
vectorBuckets: {
enabled: boolean
maxBuckets: number
maxIndexes: number
}
}
/** Format: int64 */
fileSizeLimit: number
migrationVersion: string | null
}
StreamableFile: Record<string, never>
SubdomainAvailabilityResponse_Output: {
available: boolean
}
SupavisorConfigResponse_Output: {
connection_string: string
/** @description Use connection_string instead */
connectionString: string
/** @enum {string} */
database_type: 'PRIMARY' | 'READ_REPLICA'
db_host: string
db_name: string
db_port: number
db_user: string
default_pool_size: number | null
identifier: string
is_using_scram_auth: boolean
max_client_conn: number | null
/** @enum {string} */
pool_mode: 'transaction' | 'session'
}
ThirdPartyAuth_Output: {
custom_jwks?: unknown
/** Format: uuid */
id: string
inserted_at: string
jwks_url?: string | null
oidc_issuer_url?: string | null
resolved_at?: string | null
resolved_jwks?: unknown
type: string
updated_at: string
}
TypescriptResponse_Output: {
types: string
}
/** @example {
* "name": "ci_secret_key_rotated",
* "description": "Rotated after March release"
* } */
UpdateApiKeyBody: {
description?: string | null
name?: string
secret_jwt_template?: {
[key: string]: unknown
} | null
}
/** @example {
* "site_url": "https://app.example.com",
* "disable_signup": false,
* "jwt_exp": 3600
* } */
UpdateAuthConfigBody: {
api_max_request_duration?: number | null
custom_oauth_enabled?: boolean
db_max_pool_size?: number | null
/** @enum {string|null} */
db_max_pool_size_unit?: 'connections' | 'percent' | null
disable_signup?: boolean | null
external_anonymous_users_enabled?: boolean | null
external_apple_additional_client_ids?: string | null
external_apple_client_id?: string | null
external_apple_email_optional?: boolean | null
external_apple_enabled?: boolean | null
external_apple_secret?: string | null
external_azure_client_id?: string | null
external_azure_email_optional?: boolean | null
external_azure_enabled?: boolean | null
external_azure_secret?: string | null
external_azure_url?: string | null
external_bitbucket_client_id?: string | null
external_bitbucket_email_optional?: boolean | null
external_bitbucket_enabled?: boolean | null
external_bitbucket_secret?: string | null
external_discord_client_id?: string | null
external_discord_email_optional?: boolean | null
external_discord_enabled?: boolean | null
external_discord_secret?: string | null
external_email_enabled?: boolean | null
external_facebook_client_id?: string | null
external_facebook_email_optional?: boolean | null
external_facebook_enabled?: boolean | null
external_facebook_secret?: string | null
external_figma_client_id?: string | null
external_figma_email_optional?: boolean | null
external_figma_enabled?: boolean | null
external_figma_secret?: string | null
external_github_client_id?: string | null
external_github_email_optional?: boolean | null
external_github_enabled?: boolean | null
external_github_secret?: string | null
external_gitlab_client_id?: string | null
external_gitlab_email_optional?: boolean | null
external_gitlab_enabled?: boolean | null
external_gitlab_secret?: string | null
external_gitlab_url?: string | null
external_google_additional_client_ids?: string | null
external_google_client_id?: string | null
external_google_email_optional?: boolean | null
external_google_enabled?: boolean | null
external_google_secret?: string | null
external_google_skip_nonce_check?: boolean | null
external_kakao_client_id?: string | null
external_kakao_email_optional?: boolean | null
external_kakao_enabled?: boolean | null
external_kakao_secret?: string | null
external_keycloak_client_id?: string | null
external_keycloak_email_optional?: boolean | null
external_keycloak_enabled?: boolean | null
external_keycloak_secret?: string | null
external_keycloak_url?: string | null
external_linkedin_oidc_client_id?: string | null
external_linkedin_oidc_email_optional?: boolean | null
external_linkedin_oidc_enabled?: boolean | null
external_linkedin_oidc_secret?: string | null
external_notion_client_id?: string | null
external_notion_email_optional?: boolean | null
external_notion_enabled?: boolean | null
external_notion_secret?: string | null
external_phone_enabled?: boolean | null
external_slack_client_id?: string | null
external_slack_email_optional?: boolean | null
external_slack_enabled?: boolean | null
external_slack_oidc_client_id?: string | null
external_slack_oidc_email_optional?: boolean | null
external_slack_oidc_enabled?: boolean | null
external_slack_oidc_secret?: string | null
external_slack_secret?: string | null
external_spotify_client_id?: string | null
external_spotify_email_optional?: boolean | null
external_spotify_enabled?: boolean | null
external_spotify_secret?: string | null
external_twitch_client_id?: string | null
external_twitch_email_optional?: boolean | null
external_twitch_enabled?: boolean | null
external_twitch_secret?: string | null
external_twitter_client_id?: string | null
external_twitter_email_optional?: boolean | null
external_twitter_enabled?: boolean | null
external_twitter_secret?: string | null
external_web3_ethereum_enabled?: boolean | null
external_web3_solana_enabled?: boolean | null
external_workos_client_id?: string | null
external_workos_enabled?: boolean | null
external_workos_secret?: string | null
external_workos_url?: string | null
external_x_client_id?: string | null
external_x_email_optional?: boolean | null
external_x_enabled?: boolean | null
external_x_secret?: string | null
external_zoom_client_id?: string | null
external_zoom_email_optional?: boolean | null
external_zoom_enabled?: boolean | null
external_zoom_secret?: string | null
hook_after_user_created_enabled?: boolean | null
hook_after_user_created_secrets?: string | null
hook_after_user_created_uri?: string | null
hook_before_user_created_enabled?: boolean | null
hook_before_user_created_secrets?: string | null
hook_before_user_created_uri?: string | null
hook_custom_access_token_enabled?: boolean | null
hook_custom_access_token_secrets?: string | null
hook_custom_access_token_uri?: string | null
hook_mfa_verification_attempt_enabled?: boolean | null
hook_mfa_verification_attempt_secrets?: string | null
hook_mfa_verification_attempt_uri?: string | null
hook_password_verification_attempt_enabled?: boolean | null
hook_password_verification_attempt_secrets?: string | null
hook_password_verification_attempt_uri?: string | null
hook_send_email_enabled?: boolean | null
hook_send_email_secrets?: string | null
hook_send_email_uri?: string | null
hook_send_sms_enabled?: boolean | null
hook_send_sms_secrets?: string | null
hook_send_sms_uri?: string | null
jwt_exp?: number | null
mailer_allow_unverified_email_sign_ins?: boolean | null
mailer_autoconfirm?: boolean | null
mailer_notifications_email_changed_enabled?: boolean | null
mailer_notifications_identity_linked_enabled?: boolean | null
mailer_notifications_identity_unlinked_enabled?: boolean | null
mailer_notifications_mfa_factor_enrolled_enabled?: boolean | null
mailer_notifications_mfa_factor_unenrolled_enabled?: boolean | null
mailer_notifications_password_changed_enabled?: boolean | null
mailer_notifications_phone_changed_enabled?: boolean | null
mailer_otp_exp?: number
mailer_otp_length?: number | null
mailer_secure_email_change_enabled?: boolean | null
mailer_subjects_confirmation?: string | null
mailer_subjects_email_change?: string | null
mailer_subjects_email_changed_notification?: string | null
mailer_subjects_identity_linked_notification?: string | null
mailer_subjects_identity_unlinked_notification?: string | null
mailer_subjects_invite?: string | null
mailer_subjects_magic_link?: string | null
mailer_subjects_mfa_factor_enrolled_notification?: string | null
mailer_subjects_mfa_factor_unenrolled_notification?: string | null
mailer_subjects_password_changed_notification?: string | null
mailer_subjects_phone_changed_notification?: string | null
mailer_subjects_reauthentication?: string | null
mailer_subjects_recovery?: string | null
mailer_templates_confirmation_content?: string | null
mailer_templates_email_change_content?: string | null
mailer_templates_email_changed_notification_content?: string | null
mailer_templates_identity_linked_notification_content?: string | null
mailer_templates_identity_unlinked_notification_content?: string | null
mailer_templates_invite_content?: string | null
mailer_templates_magic_link_content?: string | null
mailer_templates_mfa_factor_enrolled_notification_content?: string | null
mailer_templates_mfa_factor_unenrolled_notification_content?: string | null
mailer_templates_password_changed_notification_content?: string | null
mailer_templates_phone_changed_notification_content?: string | null
mailer_templates_reauthentication_content?: string | null
mailer_templates_recovery_content?: string | null
mfa_max_enrolled_factors?: number | null
mfa_phone_enroll_enabled?: boolean | null
mfa_phone_max_frequency?: number | null
mfa_phone_otp_length?: number | null
mfa_phone_template?: string | null
mfa_phone_verify_enabled?: boolean | null
mfa_totp_enroll_enabled?: boolean | null
mfa_totp_verify_enabled?: boolean | null
mfa_web_authn_enroll_enabled?: boolean | null
mfa_web_authn_verify_enabled?: boolean | null
nimbus_oauth_client_id?: string | null
nimbus_oauth_client_secret?: string | null
oauth_server_allow_dynamic_registration?: boolean | null
oauth_server_authorization_path?: string | null
oauth_server_enabled?: boolean | null
passkey_enabled?: boolean
password_hibp_enabled?: boolean | null
password_min_length?: number | null
/** @enum {string|null} */
password_required_characters?:
| 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789'
| 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789'
| 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789:!@#$%^&*()_+-=[]{};\'\\\\:"|<>?,./`~'
| ''
| null
rate_limit_anonymous_users?: number | null
rate_limit_email_sent?: number | null
rate_limit_otp?: number | null
rate_limit_sms_sent?: number | null
rate_limit_token_refresh?: number | null
rate_limit_verify?: number | null
rate_limit_web3?: number | null
refresh_token_rotation_enabled?: boolean | null
saml_enabled?: boolean | null
saml_external_url?: string | null
security_captcha_enabled?: boolean | null
/** @enum {string|null} */
security_captcha_provider?: 'turnstile' | 'hcaptcha' | null
security_captcha_secret?: string | null
security_manual_linking_enabled?: boolean | null
/** @description Refresh token reuse interval in seconds. Maximum 300 seconds (5 minutes). */
security_refresh_token_reuse_interval?: number | null
security_sb_forwarded_for_enabled?: boolean | null
/** @description Require the user's current password when updating their password. */
security_update_password_require_current_password?: boolean | null
security_update_password_require_reauthentication?: boolean | null
/** @description Session inactivity timeout in hours. Maximum 8760 hours (1 year). */
sessions_inactivity_timeout?: number | null
sessions_single_per_user?: boolean | null
sessions_tags?: string | null
/** @description Session timebox in hours. Maximum 8760 hours (1 year). */
sessions_timebox?: number | null
site_url?: string | null
sms_autoconfirm?: boolean | null
sms_max_frequency?: number | null
sms_messagebird_access_key?: string | null
sms_messagebird_originator?: string | null
sms_otp_exp?: number | null
sms_otp_length?: number
/** @enum {string|null} */
sms_provider?: 'messagebird' | 'textlocal' | 'twilio' | 'twilio_verify' | 'vonage' | null
sms_template?: string | null
sms_test_otp?: string | null
/** Format: date-time */
sms_test_otp_valid_until?: string | null
sms_textlocal_api_key?: string | null
sms_textlocal_sender?: string | null
sms_twilio_account_sid?: string | null
sms_twilio_auth_token?: string | null
sms_twilio_content_sid?: string | null
sms_twilio_message_service_sid?: string | null
sms_twilio_verify_account_sid?: string | null
sms_twilio_verify_auth_token?: string | null
sms_twilio_verify_message_service_sid?: string | null
sms_vonage_api_key?: string | null
sms_vonage_api_secret?: string | null
sms_vonage_from?: string | null
/** Format: email */
smtp_admin_email?: string | null
smtp_host?: string | null
smtp_max_frequency?: number | null
smtp_pass?: string | null
smtp_port?: string | null
smtp_sender_name?: string | null
smtp_user?: string | null
uri_allow_list?: string | null
webauthn_rp_display_name?: string | null
webauthn_rp_id?: string | null
webauthn_rp_origins?: string | null
}
/** @example {
* "branch_name": "preview-login-page",
* "git_branch": "feature/login-page",
* "persistent": true,
* "request_review": true,
* "notify_url": "https://example.com/webhooks/branches"
* } */
UpdateBranchBody: {
branch_name?: string
git_branch?: string
/**
* Format: uri
* @description HTTP endpoint to receive branch status updates.
*/
notify_url?: string
persistent?: boolean
request_review?: boolean
/**
* @deprecated
* @description This field is deprecated and will be ignored. Use v1-reset-a-branch endpoint directly instead.
*/
reset_on_push?: boolean
/** @enum {string} */
status?:
| 'CREATING_PROJECT'
| 'RUNNING_MIGRATIONS'
| 'MIGRATIONS_PASSED'
| 'MIGRATIONS_FAILED'
| 'FUNCTIONS_DEPLOYED'
| 'FUNCTIONS_FAILED'
}
/** @example {
* "custom_hostname": "docs.example.com"
* } */
UpdateCustomHostnameBody: {
custom_hostname: string
}
UpdateCustomHostnameResponse_Output: {
custom_hostname?: string
data: {
errors: components['schemas']['JsonValue_Output'][]
messages: components['schemas']['JsonValue_Output'][]
result: {
custom_origin_server?: string
hostname: string
id: string
ownership_verification?: {
name?: string
type?: string
value?: string
}
ssl?: {
status?: string
validation_errors?: {
message: string
}[]
validation_records?: {
txt_name?: string
txt_value?: string
}[]
}
status?: string
verification_errors?: string[]
}
success: boolean
}
/** @enum {string} */
status:
| '1_not_started'
| '2_initiated'
| '3_challenge_verified'
| '4_origin_setup_completed'
| '5_services_reconfigured'
}
/** @example {
* "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
* }
* ]
* } */
UpdateJitAccessBody: {
roles: {
allowed_networks?: {
allowed_cidrs?: {
/** Format: cidrv4 */
cidr: string
}[]
allowed_cidrs_v6?: {
/** Format: cidrv6 */
cidr: string
}[]
}
branches_only?: boolean
expires_at?: number
role: string
}[]
/** Format: uuid */
user_id: string
}
/** @example {
* "root_key": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
* } */
UpdatePgsodiumConfigBody: {
/** @description The pgsodium root key: 32 bytes, hex-encoded (64 characters). */
root_key: string
}
/** @example {
* "max_connections": 120,
* "shared_buffers": "256MB",
* "work_mem": "4MB",
* "statement_timeout": "60000ms"
* } */
UpdatePostgresConfigBody: {
autovacuum_max_workers?: number
autovacuum_work_mem?: string
/** @description Default unit: s */
checkpoint_timeout?: string
'cron.log_statement'?: boolean
effective_cache_size?: string
hot_standby_feedback?: boolean
/** @description Default unit: ms */
log_autovacuum_min_duration?: string
log_checkpoints?: boolean
log_connections?: boolean
log_disconnections?: boolean
log_duration?: boolean
log_lock_waits?: boolean
log_recovery_conflict_waits?: boolean
log_replication_commands?: boolean
/** @description Default unit: ms */
log_startup_progress_interval?: string
log_temp_files?: string
logical_decoding_work_mem?: string
maintenance_work_mem?: string
max_connections?: number
max_locks_per_transaction?: number
max_logical_replication_workers?: number
max_parallel_maintenance_workers?: number
max_parallel_workers?: number
max_parallel_workers_per_gather?: number
max_replication_slots?: number
max_slot_wal_keep_size?: string
max_standby_archive_delay?: string
max_standby_streaming_delay?: string
max_sync_workers_per_subscription?: number
max_wal_senders?: number
max_wal_size?: string
max_worker_processes?: number
'pg_net.batch_size'?: number
'pg_stat_statements.max'?: number
restart_database?: boolean
/** @enum {string} */
session_replication_role?: 'origin' | 'replica' | 'local'
shared_buffers?: string
/** @description Default unit: ms */
statement_timeout?: string
track_activity_query_size?: string
track_commit_timestamp?: boolean
wal_keep_size?: string
/** @description Default unit: ms */
wal_sender_timeout?: string
work_mem?: string
}
/** @example {
* "metadata_url": "https://sso.acme.com/metadata.xml",
* "domains": [
* "acme.com",
* "contractors.acme.com"
* ]
* } */
UpdateProviderBody: {
attribute_mapping?: {
keys: {
[key: string]: {
array?: boolean
default?: Record<string, never> | number | string | boolean
name?: string
names?: string[]
}
}
}
domains?: string[]
metadata_url?: string
metadata_xml?: string
/** @enum {string} */
name_id_format?:
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
}
UpdateProviderResponse_Output: {
created_at?: string
domains?: {
created_at?: string
domain?: string
updated_at?: string
}[]
id: string
saml?: {
attribute_mapping?: {
keys: {
[key: string]: {
array?: boolean
default?: Record<string, never> | number | string | boolean
name?: string
names?: string[]
}
}
}
entity_id: string
metadata_url?: string
metadata_xml?: string
/** @enum {string} */
name_id_format?:
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
}
updated_at?: string
}
/** @example {
* "private_only": false,
* "max_concurrent_users": 1000,
* "max_channels_per_client": 100
* } */
UpdateRealtimeConfigBody: {
/** @description Sets connection pool size for Realtime Authorization */
connection_pool?: number
/** @description Sets maximum number of bytes per second rate per channel limit */
max_bytes_per_second?: number
/** @description Sets maximum number of channels per client rate limit */
max_channels_per_client?: number
/** @description Sets maximum number of concurrent users rate limit */
max_concurrent_users?: number
/** @description Sets maximum number of events per second rate per channel limit */
max_events_per_second?: number
/** @description Sets maximum number of joins per second rate limit */
max_joins_per_second?: number
/** @description Sets maximum number of payload size in KB rate limit */
max_payload_size_in_kb?: number
/** @description Sets maximum number of presence events per second rate limit */
max_presence_events_per_second?: number
/** @description Sets connection pool size used to create Postgres Changes subscriptions */
postgres_changes_pool?: number
/** @description Whether to enable presence */
presence_enabled?: boolean
/** @description Whether to only allow private channels */
private_only?: boolean
/** @description Disables the Realtime service for this project when true. Set to false to re-enable it. */
suspend?: boolean
}
/** @example {
* "clone": "RUNNING",
* "configure": "RUNNING",
* "migrate": "RUNNING",
* "deploy": "CREATED"
* } */
UpdateRunStatusBody: {
/** @enum {string} */
clone?: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
/** @enum {string} */
configure?: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
/** @enum {string} */
deploy?: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
/** @enum {string} */
health?: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
/** @enum {string} */
migrate?: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
/** @enum {string} */
pull?: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
/** @enum {string} */
seed?: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
}
UpdateRunStatusResponse_Output: {
/** @enum {string} */
message: 'ok'
}
/** @example {
* "status": "standby"
* } */
UpdateSigningKeyBody: {
/** @enum {string} */
status: 'in_use' | 'previously_used' | 'revoked' | 'standby'
}
/** @example {
* "fileSizeLimit": 10485760,
* "features": {
* "imageTransformation": {
* "enabled": true
* }
* }
* } */
UpdateStorageConfigBody: {
external?: {
/** @enum {string} */
upstreamTarget: 'main' | 'canary'
}
features?: {
icebergCatalog?: {
enabled: boolean
maxCatalogs: number
maxNamespaces: number
maxTables: number
}
imageTransformation?: {
enabled: boolean
}
purgeCache?: {
enabled: boolean
}
s3Protocol?: {
enabled: boolean
}
vectorBuckets?: {
enabled: boolean
maxBuckets: number
maxIndexes: number
}
}
/** Format: int64 */
fileSizeLimit?: number
}
/** @example {
* "default_pool_size": 25,
* "pool_mode": "transaction"
* } */
UpdateSupavisorConfigBody: {
default_pool_size?: number | null
/**
* @description Dedicated pooler mode for the project
* @enum {string}
*/
pool_mode?: 'transaction' | 'session'
}
UpdateSupavisorConfigResponse_Output: {
default_pool_size: number | null
pool_mode: string
}
/** @example {
* "target_version": "17",
* "release_channel": "ga"
* } */
UpgradeDatabaseBody: {
/** @enum {string} */
release_channel?: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
target_version: string
}
V1BackupScheduleResponse_Output: {
/**
* @description Time of day to schedule daily backups, in UTC. Format: HH:MM:SS.
* @example 04:00:00
*/
schedule_for: string
/**
* Format: date-time
* @description Timestamp of when the backup schedule was last updated.
* @example 2026-05-04T14:40:44+00:00
*/
updated_at: string
}
V1BackupsResponse_Output: {
backups: {
id: number
inserted_at: string
is_physical_backup: boolean
/** @enum {string} */
status: 'COMPLETED' | 'FAILED' | 'PENDING' | 'REMOVED' | 'ARCHIVED' | 'CANCELLED'
}[]
physical_backup_data: {
earliest_physical_backup_date_unix?: number
latest_physical_backup_date_unix?: number
}
pitr_enabled: boolean
region: string
walg_enabled: boolean
}
/** @example {
* "slug": "hello-world",
* "name": "Hello World",
* "body": "Deno.serve(() => new Response('Hello, world!'))",
* "verify_jwt": true
* } */
V1CreateFunctionBody: {
body: string
name: string
slug: string
verify_jwt?: boolean
}
/** @example {
* "query": "create table public.widgets(id bigint primary key);",
* "name": "create_widgets_table",
* "rollback": "drop table if exists public.widgets;"
* } */
V1CreateMigrationBody: {
name?: string
query: string
rollback?: string
}
/** @example {
* "db_pass": "correct-horse-battery-staple",
* "name": "acme-prod",
* "organization_slug": "tsrqponmlkjihgfedcba",
* "region": "us-east-1"
* } */
V1CreateProjectBody: {
/** @description Database password */
db_pass: string
/**
* @description Desired instance size. Omit this field to always default to the smallest possible size.
* @enum {string}
*/
desired_instance_size?:
| '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'
/** @description [Experimental] Whether to enable high availability for the project. */
high_availability?: boolean
/**
* @deprecated
* @description This field is deprecated and is ignored in this request
*/
kps_enabled?: boolean
/** @description Name of your project */
name: string
/**
* @deprecated
* @description Deprecated: Use `organization_slug` instead.
*/
organization_id?: string
/**
* @description Organization slug
* @example tsrqponmlkjihgfedcba
*/
organization_slug: string
/**
* @deprecated
* @description Subscription Plan is now set on organization level and is ignored in this request
* @enum {string}
*/
plan?: 'free' | 'pro'
/** @deprecated */
postgres_engine?: null
/**
* @deprecated
* @description Region you want your server to reside in. Use region_selection instead.
* @enum {string}
*/
region?:
| 'us-east-1'
| 'us-east-2'
| 'us-west-1'
| 'us-west-2'
| 'ap-east-1'
| 'ap-southeast-1'
| 'ap-northeast-1'
| 'ap-northeast-2'
| 'ap-southeast-2'
| 'eu-west-1'
| 'eu-west-2'
| 'eu-west-3'
| 'eu-north-1'
| 'eu-central-1'
| 'eu-central-2'
| 'ca-central-1'
| 'ap-south-1'
| 'sa-east-1'
/** @description Region selection. Only one of region or region_selection can be specified. */
region_selection?:
| {
/**
* @description Specific region code. The codes supported are not a stable API, and should be retrieved from the /available-regions endpoint.
* @enum {string}
*/
code:
| 'us-east-1'
| 'us-east-2'
| 'us-west-1'
| 'us-west-2'
| 'ap-east-1'
| 'ap-southeast-1'
| 'ap-northeast-1'
| 'ap-northeast-2'
| 'ap-southeast-2'
| 'eu-west-1'
| 'eu-west-2'
| 'eu-west-3'
| 'eu-north-1'
| 'eu-central-1'
| 'eu-central-2'
| 'ca-central-1'
| 'ap-south-1'
| 'sa-east-1'
/** @enum {string} */
type: 'specific'
}
| {
/**
* @description The Smart Region Group's code. The codes supported are not a stable API, and should be retrieved from the /available-regions endpoint.
* @enum {string}
*/
code: 'americas' | 'emea' | 'apac'
/** @enum {string} */
type: 'smartGroup'
}
/** @deprecated */
release_channel?: null
/**
* Format: uri
* @description Template URL used to create the project from the CLI.
*/
template_url?: string
}
V1GetMigrationResponse_Output: {
created_by?: string
idempotency_key?: string
name?: string
rollback?: string[]
statements?: string[]
version: string
}
V1GetUsageApiCountResponse_Output: {
error?:
| string
| {
code: number
errors: {
domain: string
location: string
locationType: string
message: string
reason: string
}[]
message: string
status: string
}
result?: {
/** Format: date-time */
timestamp: string
total_auth_requests: number
total_realtime_requests: number
total_rest_requests: number
total_storage_requests: number
}[]
}
V1GetUsageApiRequestsCountResponse_Output: {
error?:
| string
| {
code: number
errors: {
domain: string
location: string
locationType: string
message: string
reason: string
}[]
message: string
status: string
}
result?: {
count: number
}[]
}
V1ListEntitlementsResponse_Output: {
entitlements: {
config:
| {
enabled: boolean
}
| {
enabled: boolean
unit: string
unlimited: boolean
value: number
}
| {
enabled: boolean
set: string[]
}
feature: {
/** @enum {string} */
key:
| 'instances.compute_update_available_sizes'
| 'instances.read_replicas'
| 'instances.disk_modifications'
| 'instances.high_availability'
| 'instances.orioledb'
| 'replication.etl'
| 'storage.max_file_size'
| 'storage.max_file_size.configurable'
| 'storage.image_transformations'
| 'storage.vector_buckets'
| 'storage.iceberg_catalog'
| 'storage.purge_cache'
| 'security.audit_logs_days'
| 'security.questionnaire'
| 'security.soc2_report'
| 'security.iso27001_certificate'
| 'security.private_link'
| 'security.enforce_mfa'
| 'log.retention_days'
| 'custom_domain'
| 'vanity_subdomain'
| 'ipv4'
| 'pitr.available_variants'
| 'log_drains'
| 'audit_log_drains'
| 'branching_limit'
| 'branching_persistent'
| 'auth.mfa_phone'
| 'auth.mfa_web_authn'
| 'auth.mfa_enhanced_security'
| 'auth.hooks'
| 'auth.platform.sso'
| 'auth.custom_jwt_template'
| 'auth.saml_2'
| 'auth.user_sessions'
| 'auth.leaked_password_protection'
| 'auth.advanced_auth_settings'
| 'auth.performance_settings'
| 'auth.password_hibp'
| 'auth.custom_oauth.max_providers'
| 'backup.retention_days'
| 'backup.restore_to_new_project'
| 'backup.schedule'
| 'function.max_count'
| 'function.size_limit_mb'
| 'realtime.max_concurrent_users'
| 'realtime.max_events_per_second'
| 'realtime.max_joins_per_second'
| 'realtime.max_channels_per_client'
| 'realtime.max_bytes_per_second'
| 'realtime.max_presence_events_per_second'
| 'realtime.max_payload_size_in_kb'
| 'project_scoped_roles'
| 'security.member_roles'
| 'project_pausing'
| 'project_cloning'
| 'project_restore_after_expiry'
| 'assistant.advance_model'
| 'integrations.github_connections'
| 'integrations.github_push_webhooks_limit'
| 'dedicated_pooler'
| 'observability.dashboard_advanced_metrics'
| 'api.members.invitations'
| 'api.members.roles'
/** @enum {string} */
type: 'boolean' | 'numeric' | 'set'
}
hasAccess: boolean
/** @enum {string} */
type: 'boolean' | 'numeric' | 'set'
}[]
}
V1ListMigrationsResponse_Output: {
name?: string
version: string
}[]
V1OrganizationMemberResponse_Output: {
avatar_url: string | null
email?: string
mfa_enabled: boolean
role_name?: string
user_id: string
user_name: string
}
V1OrganizationSlugResponse_Output: {
allowed_release_channels: ('internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview')[]
id: string
name: string
opt_in_tags: (
| 'AI_SQL_GENERATOR_OPT_IN'
| 'AI_DATA_GENERATOR_OPT_IN'
| 'AI_LOG_GENERATOR_OPT_IN'
)[]
/** @enum {string} */
plan?: 'free' | 'pro' | 'team' | 'enterprise' | 'platform'
}
/** @example {
* "name": "create_widgets_table",
* "rollback": "drop table if exists public.widgets;"
* } */
V1PatchMigrationBody: {
name?: string
rollback?: string
}
V1PgbouncerConfigResponse_Output: {
connection_string?: string
default_pool_size?: number
ignore_startup_parameters?: string
max_client_conn?: number
/** @enum {string} */
pool_mode?: 'transaction' | 'session' | 'statement'
query_wait_timeout?: number
reserve_pool_size?: number
server_idle_timeout?: number
server_lifetime?: number
}
V1PostgrestConfigResponse_Output: {
db_extra_search_path: string
/** @description If `null`, the value is automatically configured based on compute size. */
db_pool: number | null
/** @description If `null`, the value is automatically configured to 10. */
db_pool_acquisition_timeout: number | null
db_schema: string
max_rows: number
}
V1ProfileResponse_Output: {
gotrue_id: string
primary_email: string
username: string
}
V1ProjectAdvisorsResponse_Output: {
lints: {
cache_key: string
categories: ('PERFORMANCE' | 'SECURITY' | 'HEALTH')[]
description: string
detail: string
/** @enum {string} */
facing: 'EXTERNAL'
/** @enum {string} */
level: 'ERROR' | 'WARN' | 'INFO'
metadata?: {
entity?: string
fkey_columns?: number[]
fkey_name?: string
name?: string
schema?: string
/** @enum {string} */
type?:
| 'table'
| 'view'
| 'materialized view'
| 'foreign table'
| 'auth'
| 'function'
| 'extension'
| 'compliance'
| 'health'
}
/** @enum {string} */
name:
| 'unindexed_foreign_keys'
| 'auth_users_exposed'
| 'auth_rls_initplan'
| 'no_primary_key'
| 'unused_index'
| 'multiple_permissive_policies'
| 'policy_exists_rls_disabled'
| 'rls_enabled_no_policy'
| 'duplicate_index'
| 'security_definer_view'
| 'function_search_path_mutable'
| 'rls_disabled_in_public'
| 'extension_in_public'
| 'rls_references_user_metadata'
| 'materialized_view_in_api'
| 'foreign_table_in_api'
| 'unsupported_reg_types'
| 'auth_otp_long_expiry'
| 'auth_otp_short_length'
| 'ssl_not_enforced'
| 'log_connections_not_enabled'
| 'network_restrictions_not_set'
| 'password_requirements_min_length'
| 'pitr_not_enabled'
| 'auth_leaked_password_protection'
| 'auth_insufficient_mfa_options'
| 'auth_password_policy_missing'
| 'leaked_service_key'
| 'no_backup_admin'
| 'vulnerable_postgres_version'
| 'db_not_reachable'
| 'db_connection_failing'
| 'db_connection_limit_reached'
| 'instance_telemetry_lost'
| 'instance_db_down'
| 'instance_alert_firing'
| 'log_data_api_error_rate_high'
| 'log_auth_error_rate_high'
| 'log_storage_error_rate_high'
| 'log_edge_function_error_rate_high'
| 'project_not_active'
| 'advisor_check_unavailable'
/** Format: date-time */
observed_at?: string
remediation: string
title: string
}[]
}
V1ProjectRefResponse_Output: {
id: number
name: string
ref: string
}
V1ProjectResponse_Output: {
/** @description Creation timestamp */
created_at: string
/**
* @deprecated
* @description Deprecated: Use `ref` instead.
*/
id: string
/** @description Name of your project */
name: string
/**
* @deprecated
* @description Deprecated: Use `organization_slug` instead.
*/
organization_id: string
/**
* @description Organization slug
* @example tsrqponmlkjihgfedcba
*/
organization_slug: string
/**
* @description Project ref
* @example abcdefghijklmnopqrst
*/
ref: string
/** @description Region of your project */
region: string
/** @enum {string} */
status:
| 'INACTIVE'
| 'ACTIVE_HEALTHY'
| 'ACTIVE_UNHEALTHY'
| 'COMING_UP'
| 'UNKNOWN'
| 'GOING_DOWN'
| 'INIT_FAILED'
| 'REMOVED'
| 'RESTORING'
| 'UPGRADING'
| 'PAUSING'
| 'RESTORE_FAILED'
| 'RESTARTING'
| 'PAUSE_FAILED'
| 'RESIZING'
}
V1ProjectWithDatabaseResponse_Output: {
/** @description Creation timestamp */
created_at: string
database: {
/** @description Database host */
host: string
/** @description Database engine */
postgres_engine: string
/** @description Release channel */
release_channel: string
/** @description Database version */
version: string
}
/**
* @deprecated
* @description Deprecated: Use `ref` instead.
*/
id: string
/** @description Name of your project */
name: string
/**
* @deprecated
* @description Deprecated: Use `organization_slug` instead.
*/
organization_id: string
/**
* @description Organization slug
* @example tsrqponmlkjihgfedcba
*/
organization_slug: string
/**
* @description Project ref
* @example abcdefghijklmnopqrst
*/
ref: string
/** @description Region of your project */
region: string
/** @enum {string} */
status:
| 'INACTIVE'
| 'ACTIVE_HEALTHY'
| 'ACTIVE_UNHEALTHY'
| 'COMING_UP'
| 'UNKNOWN'
| 'GOING_DOWN'
| 'INIT_FAILED'
| 'REMOVED'
| 'RESTORING'
| 'UPGRADING'
| 'PAUSING'
| 'RESTORE_FAILED'
| 'RESTARTING'
| 'PAUSE_FAILED'
| 'RESIZING'
}
/** @example {
* "query": "select * from pg_stat_activity limit 1;"
* } */
V1ReadOnlyQueryBody: {
parameters?: unknown[]
query: string
}
/** @example {
* "id": 12345
* } */
V1RestoreBackupBody: {
id: number
}
/** @example {
* "recovery_time_target_unix": 1740787200
* } */
V1RestorePitrBody: {
/** Format: int64 */
recovery_time_target_unix: number
}
/** @example {
* "name": "before-upgrade"
* } */
V1RestorePointPostBody: {
name: string
}
V1RestorePointResponse: {
/** Format: date-time */
completed_on: string | null
name: string
/** @enum {string} */
status: 'AVAILABLE' | 'PENDING' | 'REMOVED' | 'FAILED'
}
/** @example {
* "query": "select * from pg_stat_activity limit 1;",
* "read_only": true
* } */
V1RunQueryBody: {
parameters?: unknown[]
query: string
read_only?: boolean
}
V1ServiceHealthResponse_Output: {
error?: string
/**
* @deprecated
* @description Deprecated. Use `status` instead.
*/
healthy: boolean
info?:
| {
description: string
/** @enum {string} */
name: 'GoTrue'
version: string
}
| {
connected_cluster: number
db_connected: boolean
/**
* @deprecated
* @description Deprecated. Use `status` instead.
*/
healthy: boolean
replication_connected: boolean
}
| {
db_schema: string
}
/** @enum {string} */
name:
| 'auth'
| 'db'
| 'db_postgres_user'
| 'pooler'
| 'realtime'
| 'rest'
| 'storage'
| 'pg_bouncer'
/** @enum {string} */
status: 'COMING_UP' | 'ACTIVE_HEALTHY' | 'UNHEALTHY'
}
V1StorageBucketResponse_Output: {
created_at: string
id: string
name: string
owner: string
public: boolean
updated_at: string
}
/** @example {
* "name": "before-upgrade"
* } */
V1UndoBody: {
name: string
}
/** @example {
* "schedule_for": "04:00:00"
* } */
V1UpdateBackupScheduleBody: {
/**
* @description Time of day to schedule daily backups, in UTC. Format: HH:MM:SS.
* @example 04:00:00
*/
schedule_for: string
}
/**
* Format: binary
* @description Raw Brotli-compressed ESZIP binary file.
*
* **Validation requirements** - The file must start with the four magic bytes `EZBR` (hex: `45 5A 42 52`).
* - The `ezbr_sha256` query parameter must contain the SHA-256 hash of the uploaded ESZIP payload.
*
* **Example**
* ```javascript
* import { readFile } from 'node:fs/promises';
* import { brotliCompress } from 'node:zlib';
* import { promisify } from 'node:util';
* import { createHash } from 'node:crypto';
*
* const compress = promisify(brotliCompress);
* const marker = Buffer.from('EZBR', 'ascii');
*
* const file = await readFile('./function.eszip');
* const compressed = await compress(file);
*
* const payload = Buffer.concat([marker, compressed]);
*
* const ezbr_sha256 = createHash('sha256')
* .update(payload)
* .digest('hex');
*
* console.log(ezbr_sha256);
* ```
*
*
*/
V1UpdateFunctionBodyEszip: string
/** @example {
* "name": "Hello World",
* "body": "Deno.serve(() => new Response('Hello again!'))",
* "verify_jwt": true
* } */
V1UpdateFunctionBodyJson: {
body?: string
name?: string
verify_jwt?: boolean
}
/** @example {
* "password": "correct-horse-battery-staple"
* } */
V1UpdatePasswordBody: {
password: string
}
V1UpdatePasswordResponse_Output: {
message: string
}
/** @example {
* "db_schema": "public,storage",
* "db_pool": 20,
* "max_rows": 1000
* } */
V1UpdatePostgrestConfigBody: {
db_extra_search_path?: string
db_pool?: number
db_pool_acquisition_timeout?: number
db_schema?: string
max_rows?: number
}
/** @example {
* "name": "Acme Platform"
* } */
V1UpdateProjectBody: {
name: string
}
/** @example {
* "query": "create table public.widgets(id bigint primary key);",
* "name": "create_widgets_table",
* "rollback": "drop table if exists public.widgets;"
* } */
V1UpsertMigrationBody: {
name?: string
query: string
rollback?: string
}
/** @example {
* "vanity_subdomain": "acme-prod"
* } */
VanitySubdomainBody: {
vanity_subdomain: string
}
VanitySubdomainConfigResponse_Output: {
custom_domain?: string
/** @enum {string} */
status: 'not-used' | 'custom-domain-used' | 'active'
}
}
responses: never
parameters: never
requestBodies: never
headers: never
pathItems: never
}
export type $defs = Record<string, never>
export interface operations {
'v1-get-a-branch-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Branch ref or deprecated branch ID */
branch_id_or_ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchDetailResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-a-branch': {
parameters: {
query?: {
/** @description If set to false, schedule deletion with 1-hour grace period (only when soft deletion is enabled). */
force?: string
}
header?: never
path: {
/** @description Branch ref or deprecated branch ID */
branch_id_or_ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchDeleteResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to delete database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-a-branch-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Branch ref or deprecated branch ID */
branch_id_or_ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateBranchBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-diff-a-branch': {
parameters: {
query?: {
included_schemas?: string
/** @description 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` */
pgdelta?: string
}
header?: never
path: {
/** @description Branch ref or deprecated branch ID */
branch_id_or_ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'text/plain': string
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to diff database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-merge-a-branch': {
parameters: {
query?: never
header?: never
path: {
/** @description Branch ref or deprecated branch ID */
branch_id_or_ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['BranchActionBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchUpdateResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to merge database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-push-a-branch': {
parameters: {
query?: never
header?: never
path: {
/** @description Branch ref or deprecated branch ID */
branch_id_or_ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['BranchActionBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchUpdateResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to push database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-reset-a-branch': {
parameters: {
query?: never
header?: never
path: {
/** @description Branch ref or deprecated branch ID */
branch_id_or_ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['BranchActionBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchUpdateResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to reset database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-restore-a-branch': {
parameters: {
query?: never
header?: never
path: {
/** @description Branch ref or deprecated branch ID */
branch_id_or_ref: string
}
cookie?: never
}
requestBody?: never
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchRestoreResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to restore database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-authorize-user': {
parameters: {
query: {
client_id: string
code_challenge?: string
code_challenge_method?: 'plain' | 'sha256' | 'S256'
/** @description Organization slug */
organization_slug?: string
redirect_uri: string
/** @description Resource indicator for MCP (Model Context Protocol) clients */
resource?: string
response_mode?: string
response_type: 'code' | 'token' | 'id_token token'
scope?: string
state?: string
target_flow?: string
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
204: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-oauth-authorize-project-claim': {
parameters: {
query: {
client_id: string
code_challenge?: string
code_challenge_method?: 'plain' | 'sha256' | 'S256'
/** @description Project ref */
project_ref: string
redirect_uri: string
response_mode?: string
response_type: 'code' | 'token' | 'id_token token'
state?: string
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
204: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-revoke-token': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['OAuthRevokeTokenBody']
}
}
responses: {
204: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-exchange-oauth-token': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody: {
content: {
'application/x-www-form-urlencoded': components['schemas']['OAuthTokenBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['OAuthTokenResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-all-organizations': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['OrganizationResponseV1_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unexpected error listing organizations */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-an-organization': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['CreateOrganizationV1']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['OrganizationResponseV1_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unexpected error creating an organization */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-an-organization': {
parameters: {
query?: never
header?: never
path: {
/** @description Organization slug */
slug: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1OrganizationSlugResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-organization-entitlements': {
parameters: {
query?: never
header?: never
path: {
/** @description Organization slug */
slug: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ListEntitlementsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-organization-members': {
parameters: {
query?: never
header?: never
path: {
/** @description Organization slug */
slug: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1OrganizationMemberResponse_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-organization-project-claim': {
parameters: {
query?: never
header?: never
path: {
/** @description Organization slug */
slug: string
token: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['OrganizationProjectClaimResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-claim-project-for-organization': {
parameters: {
query?: never
header?: never
path: {
/** @description Organization slug */
slug: string
token: string
}
cookie?: never
}
requestBody?: never
responses: {
204: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-all-projects-for-organization': {
parameters: {
query?: {
/** @description Number of projects to return per page */
limit?: number
/** @description Number of projects to skip */
offset?: number
/** @description Search projects by name */
search?: string
/** @description Sort order for projects */
sort?: 'name_asc' | 'name_desc' | 'created_asc' | 'created_desc'
/** @description A comma-separated list of project statuses to filter by.
*
* The following values are supported: `ACTIVE_HEALTHY`, `INACTIVE`. */
statuses?: string
}
header?: never
path: {
/** @description Organization slug */
slug: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['OrganizationProjectsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve projects */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-profile': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ProfileResponse_Output']
}
}
}
}
'v1-list-all-projects': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ProjectWithDatabaseResponse_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-a-project': {
parameters: {
query?: never
header?: never
path?: never
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1CreateProjectBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ProjectResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ProjectWithDatabaseResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-a-project': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ProjectRefResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-a-project': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1UpdateProjectBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ProjectRefResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-action-runs': {
parameters: {
query?: {
limit?: number
offset?: number
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ListActionRunResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to list action runs */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-count-action-runs': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
/** @description total count value */
'X-Total-Count'?: number
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to count action runs */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-action-run': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
/** @description Action Run ID */
run_id: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ActionRunResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get action run status */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-action-run-logs': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
/** @description Action Run ID */
run_id: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'text/plain': string
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get action run logs */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-action-run-status': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
/** @description Action Run ID */
run_id: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateRunStatusBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['UpdateRunStatusResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update action run status */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-performance-advisors': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ProjectAdvisorsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-security-advisors': {
parameters: {
query?: {
lint_type?: 'sql'
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ProjectAdvisorsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-function-combined-stats': {
parameters: {
query: {
function_id: string
interval: '15min' | '1hr' | '3hr' | '1day'
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get project's function combined statistics */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-logs': {
parameters: {
query?: {
iso_timestamp_end?: string
iso_timestamp_start?: string
/** @description Custom SQL query to execute on the logs. See [querying logs](https://supabase.com/docs/guides/monitoring-and-debugging/logs#querying-with-the-logs-explorer) for more details. */
sql?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Usage exceeded. Enable additional usage to continue querying */
402: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-logs-all': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description This endpoint has been removed */
410: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-scrape-project-metrics': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description Prometheus / OpenMetrics text exposition */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/openmetrics-text': string
'text/plain': string
}
}
/** @description Project must be active and healthy, or metrics are not available for this project */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to fetch project's metrics */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-usage-api-count': {
parameters: {
query?: {
interval?: '15min' | '30min' | '1hr' | '3hr' | '1day' | '3day' | '7day'
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1GetUsageApiCountResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get project's usage api counts */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-usage-request-count': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1GetUsageApiRequestsCountResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get project's usage api requests count */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-api-keys': {
parameters: {
query?: {
/** @description Boolean string.
*
* Truthy values: `true`, `1`, `yes`, `on`, `y`, `enabled`
*
* Falsy values: `false`, `0`, `no`, `off`, `n`, `disabled` */
reveal?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ApiKeyResponse_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-project-api-key': {
parameters: {
query?: {
/** @description Boolean string.
*
* Truthy values: `true`, `1`, `yes`, `on`, `y`, `enabled`
*
* Falsy values: `false`, `0`, `no`, `off`, `n`, `disabled` */
reveal?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['CreateApiKeyBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ApiKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-api-key': {
parameters: {
query?: {
/** @description Boolean string.
*
* Truthy values: `true`, `1`, `yes`, `on`, `y`, `enabled`
*
* Falsy values: `false`, `0`, `no`, `off`, `n`, `disabled` */
reveal?: string
}
header?: never
path: {
id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ApiKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-project-api-key': {
parameters: {
query?: {
reason?: string
/** @description Boolean string, true or false */
reveal?: string
/** @description Boolean string, true or false */
was_compromised?: string
}
header?: never
path: {
id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ApiKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-project-api-key': {
parameters: {
query?: {
/** @description Boolean string.
*
* Truthy values: `true`, `1`, `yes`, `on`, `y`, `enabled`
*
* Falsy values: `false`, `0`, `no`, `off`, `n`, `disabled` */
reveal?: string
}
header?: never
path: {
id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateApiKeyBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ApiKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-legacy-api-keys': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['LegacyApiKeysResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-project-legacy-api-keys': {
parameters: {
query: {
/** @description Boolean string.
*
* Truthy values: `true`, `1`, `yes`, `on`, `y`, `enabled`
*
* Falsy values: `false`, `0`, `no`, `off`, `n`, `disabled` */
enabled: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['LegacyApiKeysResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-project-addons': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ListProjectAddonsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to list project addons */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-apply-project-addon': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['ApplyProjectAddonBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to apply project addon */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-remove-project-addon': {
parameters: {
query?: never
header?: never
path: {
addon_variant:
| (
| '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'
)
| 'cd_default'
| ('pitr_7' | 'pitr_14' | 'pitr_28')
| 'ipv4_default'
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to remove project addon */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-all-branches': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchResponse_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve database branches */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-a-branch': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['CreateBranchBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to create database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-disable-preview-branching': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to disable preview branching */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-a-branch': {
parameters: {
query?: never
header?: never
path: {
name: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BranchResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to fetch database branch */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-claim-token': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ProjectClaimTokenResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-project-claim-token': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['CreateProjectClaimTokenResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-project-claim-token': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
204: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-login-role': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['CreateRoleBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['CreateRoleResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to create login role */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-login-roles': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['DeleteRolesResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to delete login roles */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-auth-service-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['AuthConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's auth config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-auth-service-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateAuthConfigBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['AuthConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project's auth config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-signing-keys': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SigningKeysResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-project-signing-key': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['CreateSigningKeyBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-signing-key': {
parameters: {
query?: never
header?: never
path: {
id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-remove-project-signing-key': {
parameters: {
query?: never
header?: never
path: {
id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-project-signing-key': {
parameters: {
query?: never
header?: never
path: {
id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateSigningKeyBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-legacy-signing-key': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-legacy-signing-key': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-all-sso-provider': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ListProvidersResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description SAML 2.0 support is not enabled for this project */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-a-sso-provider': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['CreateProviderBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['CreateProviderResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description SAML 2.0 support is not enabled for this project */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-a-sso-provider': {
parameters: {
query?: never
header?: never
path: {
provider_id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['GetProviderResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Either SAML 2.0 was not enabled for this project, or the provider does not exist */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-a-sso-provider': {
parameters: {
query?: never
header?: never
path: {
provider_id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateProviderBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['UpdateProviderResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Either SAML 2.0 was not enabled for this project, or the provider does not exist */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-a-sso-provider': {
parameters: {
query?: never
header?: never
path: {
provider_id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['DeleteProviderResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Either SAML 2.0 was not enabled for this project, or the provider does not exist */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-project-tpa-integrations': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ThirdPartyAuth_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-project-tpa-integration': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['CreateThirdPartyAuthBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ThirdPartyAuth_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-tpa-integration': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
tpa_id: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ThirdPartyAuth_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-project-tpa-integration': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
tpa_id: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ThirdPartyAuth_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-pgbouncer-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1PgbouncerConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's pgbouncer config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-pooler-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SupavisorConfigResponse_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's supavisor config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-pooler-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateSupavisorConfigBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['UpdateSupavisorConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project's supavisor config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-postgres-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PostgresConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's Postgres config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-postgres-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdatePostgresConfigBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PostgresConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project's Postgres config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-database-disk': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['DiskResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get database disk attributes */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-modify-database-disk': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['DiskRequestBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to modify database disk */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-project-disk-autoscale-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['DiskAutoscaleConfig_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get project disk autoscale config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-disk-utilization': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['DiskUtilMetricsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get disk utilization */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-realtime-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description Gets project's realtime configuration */
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['RealtimeConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-realtime-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateRealtimeConfigBody']
}
}
responses: {
204: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-shutdown-realtime': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
/** @description Realtime connections shutdown successfully */
204: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Tenant not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-storage-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['StorageConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's storage config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-storage-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateStorageConfigBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project's storage config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-hostname-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['UpdateCustomHostnameResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's custom hostname config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-Delete hostname config': {
parameters: {
query?: {
/** @description If true, also removes the custom domain add-on from the project subscription. */
remove_addon?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to delete project custom hostname configuration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-activate-custom-hostname': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['UpdateCustomHostnameResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to activate project custom hostname configuration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-hostname-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateCustomHostnameBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['UpdateCustomHostnameResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project custom hostname configuration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-verify-dns-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['UpdateCustomHostnameResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to verify project custom hostname configuration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-all-backups': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1BackupsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get backups */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-restore-physical-backup': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1RestoreBackupBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-restore-pitr-backup': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1RestorePitrBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-restore-point': {
parameters: {
query?: {
name?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1RestorePointResponse']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get requested restore points */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-restore-point': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1RestorePointPostBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1RestorePointResponse']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-backup-schedule': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1BackupScheduleResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description This feature requires the Enterprise organization plan. */
402: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PlanGateErrorBody']
}
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Project or backup schedule not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve backup schedule */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-backup-schedule': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1UpdateBackupScheduleBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1BackupScheduleResponse_Output']
}
}
/** @description Invalid schedule_for format */
400: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description This feature requires the Enterprise organization plan. */
402: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PlanGateErrorBody']
}
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Project or backup schedule not found */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update backup schedule */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-undo': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1UndoBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-database-metadata': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['GetProjectDbMetadataResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-jit-access': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['JitAccessResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to list database jit access */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-jit-access': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdateJitAccessBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['JitAccessResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update JIT access */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-authorize-jit-access': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['AuthorizeJitAccessBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['JitAuthorizeAccessResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to authorize database jit access */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-jit-access': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
user_id: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to remove JIT access */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-invite-external-jit-access': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['InviteExternalUserJitAccessBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['InviteExternalUserJitResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to invite external user */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-invite-external-jit-access': {
parameters: {
query?: never
header?: never
path: {
invite_id: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to revoke invite for external user */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-accept-invite-external-jit-access': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['AcceptInviteExternalUserJitAccessBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['JitAccessResponse_Output']
}
}
/** @description Failed to accept invitation */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-jit-access': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['JitListAccessResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to list database jit access */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-migration-history': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ListMigrationsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to list database migrations */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-upsert-a-migration': {
parameters: {
query?: never
header?: {
/** @description A unique key to ensure the same migration is tracked only once. */
'Idempotency-Key'?: string
}
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1UpsertMigrationBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to upsert database migration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-apply-a-migration': {
parameters: {
query?: never
header?: {
/** @description A unique key to ensure the same migration is tracked only once. */
'Idempotency-Key'?: string
}
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1CreateMigrationBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to apply database migration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-rollback-migrations': {
parameters: {
query: {
/** @description Rollback migrations greater or equal to this version */
gte: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to rollback database migration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-a-migration': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
version: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1GetMigrationResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get database migration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-patch-a-migration': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
version: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1PatchMigrationBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to patch database migration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-database-openapi': {
parameters: {
query?: {
/** @description The database schema to generate the OpenAPI spec for */
schema?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': Record<string, never>
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to fetch PostgREST OpenAPI spec */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-database-password': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1UpdatePasswordBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1UpdatePasswordResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update database password */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-run-a-query': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1RunQueryBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to run sql query */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-read-only-query': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1ReadOnlyQueryBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to run read-only sql query */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-enable-database-webhook': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
201: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to enable Database Webhooks on the project */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-all-functions': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['FunctionResponse_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's functions */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-bulk-update-functions': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['BulkUpdateFunctionBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['BulkUpdateFunctionResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Maximum number of functions reached for Plan */
402: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update functions */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-create-a-function': {
parameters: {
query?: {
entrypoint_path?: string
ezbr_sha256?: string
import_map?: string
import_map_path?: string
name?: string
slug?: string
verify_jwt?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1CreateFunctionBody']
'application/vnd.denoland.eszip': string
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['FunctionResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Maximum number of functions reached for Plan */
402: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to create project's function */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-a-function': {
parameters: {
query?: never
header?: never
path: {
/** @description Function slug */
function_slug: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['FunctionSlugResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve function with given slug */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-a-function': {
parameters: {
query?: never
header?: never
path: {
/** @description Function slug */
function_slug: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to delete function with given slug */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-a-function': {
parameters: {
query?: {
entrypoint_path?: string
ezbr_sha256?: string
import_map?: string
import_map_path?: string
name?: string
slug?: string
verify_jwt?: string
}
header?: never
path: {
/** @description Function slug */
function_slug: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1UpdateFunctionBodyJson']
'application/vnd.denoland.eszip': components['schemas']['V1UpdateFunctionBodyEszip']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['FunctionSlugResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update function with given slug */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-a-function-body': {
parameters: {
query?: never
header?: never
path: {
/** @description Function slug */
function_slug: string
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['StreamableFile']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve function body with given slug */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-deploy-a-function': {
parameters: {
query?: {
bundleOnly?: string
slug?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'multipart/form-data': components['schemas']['FunctionDeployBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['DeployFunctionResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Maximum number of functions reached for Plan */
402: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to deploy function */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-services-health': {
parameters: {
query: {
/** @description Comma-separated list of enums or array of enums. */
services:
| string
| (
| 'auth'
| 'db'
| 'db_postgres_user'
| 'pooler'
| 'realtime'
| 'rest'
| 'storage'
| 'pg_bouncer'
)[]
timeout_ms?: number
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1ServiceHealthResponse_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's service health status */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-jit-access-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json':
| {
appliedSuccessfully?: boolean
/** @enum {string} */
state: 'enabled' | 'disabled'
}
| {
/** @constant */
state: 'unavailable'
/** @enum {string} */
unavailableReason:
| 'platform_unsupported'
| 'postgres_upgrade_required'
| 'ssl_enforcement_required'
| 'temporarily_unavailable'
}
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's temporary access configuration. */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-jit-access-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['JitAccessRequestRequest']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json':
| {
appliedSuccessfully?: boolean
/** @enum {string} */
state: 'enabled' | 'disabled'
}
| {
/** @constant */
state: 'unavailable'
/** @enum {string} */
unavailableReason:
| 'platform_unsupported'
| 'postgres_upgrade_required'
| 'ssl_enforcement_required'
| 'temporarily_unavailable'
}
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project's temporary access configuration. */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-delete-network-bans': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['RemoveNetworkBanRequest']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to remove network bans. */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-all-network-bans': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['NetworkBanResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's network bans */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-all-network-bans-enriched': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['NetworkBanResponseEnriched_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's enriched network bans */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-network-restrictions': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['NetworkRestrictionsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's network restrictions */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-patch-network-restrictions': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['NetworkRestrictionsPatchRequest']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['NetworkRestrictionsV2Response_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project network restrictions */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-network-restrictions': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['NetworkRestrictionsRequest']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['NetworkRestrictionsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project network restrictions */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-pause-a-project': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-pgsodium-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PgsodiumConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's pgsodium config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-pgsodium-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpdatePgsodiumConfigBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PgsodiumConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project's pgsodium config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-postgrest-service-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PostgrestConfigWithJWTSecretResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's postgrest config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-postgrest-service-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['V1UpdatePostgrestConfigBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1PostgrestConfigResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project's postgrest config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-remove-a-read-replica': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['RemoveReadReplicaBody']
}
}
responses: {
204: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to remove read replica */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-setup-a-read-replica': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['SetUpReadReplicaBody']
}
}
responses: {
204: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description This feature requires the Pro, Team, or Enterprise organization plan. */
402: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PlanGateErrorBody']
}
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to set up read replica */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-readonly-mode-status': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ReadOnlyStatusResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get project readonly mode status */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-disable-readonly-mode-temporarily': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
201: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to disable project's readonly mode */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-restart-a-project': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-available-restore-versions': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['GetProjectAvailableRestoreVersionsResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-restore-a-project': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-cancel-a-project-restoration': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-all-secrets': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SecretResponse_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's secrets */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-bulk-create-secrets': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['CreateSecretBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to create project's secrets */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-bulk-delete-secrets': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['DeleteSecretsBody']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to delete secrets with given names */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-ssl-enforcement-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SslEnforcementResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project's SSL enforcement config */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-update-ssl-enforcement-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['SslEnforcementRequest']
}
}
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SslEnforcementResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to update project's SSL enforcement configuration. */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-list-all-buckets': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['V1StorageBucketResponse_Output'][]
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get list of buckets */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-generate-typescript-types': {
parameters: {
query?: {
included_schemas?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['TypescriptResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to generate TypeScript types */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-upgrade-postgres-version': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['UpgradeDatabaseBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ProjectUpgradeInitiateResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to initiate project upgrade */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-postgres-upgrade-eligibility': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ProjectUpgradeEligibilityResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to determine project upgrade eligibility */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-postgres-upgrade-status': {
parameters: {
query?: {
tracking_id?: string
}
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['DatabaseUpgradeStatusResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve project upgrade status */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-vanity-subdomain-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['VanitySubdomainConfigResponse_Output']
}
}
/** @description This feature requires the Pro, Team, or Enterprise organization plan. */
400: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PlanGateErrorBody']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to get project vanity subdomain configuration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-deactivate-vanity-subdomain-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to delete project vanity subdomain configuration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-activate-vanity-subdomain-config': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['VanitySubdomainBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ActivateVanitySubdomainResponse_Output']
}
}
/** @description This feature requires the Pro, Team, or Enterprise organization plan. */
400: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PlanGateErrorBody']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to activate project vanity subdomain configuration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-check-vanity-subdomain-availability': {
parameters: {
query?: never
header?: never
path: {
/** @description Project ref */
ref: string
}
cookie?: never
}
requestBody: {
content: {
'application/json': components['schemas']['VanitySubdomainBody']
}
}
responses: {
201: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SubdomainAvailabilityResponse_Output']
}
}
/** @description This feature requires the Pro, Team, or Enterprise organization plan. */
400: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['PlanGateErrorBody']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to check project vanity subdomain configuration */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-available-regions': {
parameters: {
query: {
/** @description Continent code to determine regional recommendations: NA (North America), SA (South America), EU (Europe), AF (Africa), AS (Asia), OC (Oceania), AN (Antarctica) */
continent?: 'NA' | 'SA' | 'EU' | 'AF' | 'AS' | 'OC' | 'AN'
/** @description Desired instance size. Omit this field to always default to the smallest possible size. */
desired_instance_size?:
| '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'
/** @description Slug of your organization */
organization_slug: string
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['RegionsInfoV1_Output']
}
}
}
}
'v1-list-all-snippets': {
parameters: {
query?: {
cursor?: string
limit?: string
/** @description Project ref */
project_ref?: string
sort_by?: 'name' | 'inserted_at'
sort_order?: 'asc' | 'desc'
}
header?: never
path?: never
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SnippetList_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to list user's SQL snippets */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
'v1-get-a-snippet': {
parameters: {
query?: never
header?: never
path: {
id: string
}
cookie?: never
}
requestBody?: never
responses: {
200: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['SnippetResponse_Output']
}
}
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Forbidden action */
403: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Rate limit exceeded */
429: {
headers: {
[name: string]: unknown
}
content?: never
}
/** @description Failed to retrieve SQL snippet */
500: {
headers: {
[name: string]: unknown
}
content?: never
}
}
}
}