Supabase API reference

New to Corsair? See API access, authentication, and error handling.

Advisors

getPerformanceAdvisors

advisors.getPerformanceAdvisors Get performance advisors Risk: read

await corsair.supabase.api.advisors.getPerformanceAdvisors({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getSecurityAdvisors

advisors.getSecurityAdvisors Get security advisors Risk: read

await corsair.supabase.api.advisors.getSecurityAdvisors({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Analytics

getProjectLogs

analytics.getProjectLogs Get project logs Risk: read

await corsair.supabase.api.analytics.getProjectLogs({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Auth

createProjectSigningKey

auth.createProjectSigningKey Create a project signing key Risk: write

await corsair.supabase.api.auth.createProjectSigningKey({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

createSsoProvider

auth.createSsoProvider Create an SSO provider Risk: write

await corsair.supabase.api.auth.createSsoProvider({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

createThirdPartyAuthIntegration

auth.createThirdPartyAuthIntegration Create a third-party auth integration Risk: write

await corsair.supabase.api.auth.createThirdPartyAuthIntegration({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteSsoProvider

auth.deleteSsoProvider Remove an SSO provider Risk: destructive · Irreversible

await corsair.supabase.api.auth.deleteSsoProvider({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	Yes	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteThirdPartyAuthIntegration

auth.deleteThirdPartyAuthIntegration Delete a third-party auth integration Risk: destructive · Irreversible

await corsair.supabase.api.auth.deleteThirdPartyAuthIntegration({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	Yes	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getLegacySigningKey

auth.getLegacySigningKey Get legacy signing key Risk: read

await corsair.supabase.api.auth.getLegacySigningKey({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectAuthConfig

auth.getProjectAuthConfig Get project auth config Risk: read

await corsair.supabase.api.auth.getProjectAuthConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectSigningKeys

auth.getProjectSigningKeys Get project signing keys Risk: read

await corsair.supabase.api.auth.getProjectSigningKeys({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getSsoProvider

auth.getSsoProvider Get an SSO provider Risk: read

await corsair.supabase.api.auth.getSsoProvider({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	Yes	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getThirdPartyIntegration

auth.getThirdPartyIntegration Get a third-party auth integration Risk: read

await corsair.supabase.api.auth.getThirdPartyIntegration({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	Yes	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listSsoProviders

auth.listSsoProviders List SSO providers Risk: read

await corsair.supabase.api.auth.listSsoProviders({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listThirdPartyAuthIntegrations

auth.listThirdPartyAuthIntegrations List third-party auth integrations Risk: read

await corsair.supabase.api.auth.listThirdPartyAuthIntegrations({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateProjectAuthConfig

auth.updateProjectAuthConfig Update project auth config Risk: write

await corsair.supabase.api.auth.updateProjectAuthConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateSsoProvider

auth.updateSsoProvider Update an SSO provider Risk: write

await corsair.supabase.api.auth.updateSsoProvider({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	Yes	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Database

applyMigration

database.applyMigration Apply a database migration Risk: write

await corsair.supabase.api.database.applyMigration({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

createLoginRole

database.createLoginRole Create a CLI login role Risk: write

await corsair.supabase.api.database.createLoginRole({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

createReadReplica

database.createReadReplica Set up a read replica Risk: write

await corsair.supabase.api.database.createReadReplica({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteLoginRoles

database.deleteLoginRoles Delete CLI login roles Risk: destructive · Irreversible

await corsair.supabase.api.database.deleteLoginRoles({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

disableProjectReadonly

database.disableProjectReadonly Temporarily disable project read-only mode Risk: write

await corsair.supabase.api.database.disableProjectReadonly({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

enableDatabaseWebhooks

database.enableDatabaseWebhooks Enable database webhooks Risk: write

await corsair.supabase.api.database.enableDatabaseWebhooks({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

generateTypescriptTypes

database.generateTypescriptTypes Generate TypeScript database types Risk: read

await corsair.supabase.api.database.generateTypescriptTypes({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getDatabaseMetadata

database.getDatabaseMetadata Get database metadata Risk: read

await corsair.supabase.api.database.getDatabaseMetadata({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getJitAccessConfig

database.getJitAccessConfig Get JIT access config Risk: read

await corsair.supabase.api.database.getJitAccessConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getMigration

database.getMigration Get a migration Risk: read

await corsair.supabase.api.database.getMigration({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	Yes	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectPgbouncerConfig

database.getProjectPgbouncerConfig Get project PgBouncer config Risk: read

await corsair.supabase.api.database.getProjectPgbouncerConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectPostgresConfig

database.getProjectPostgresConfig Get project postgres config Risk: read

await corsair.supabase.api.database.getProjectPostgresConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectReadonlyModeStatus

database.getProjectReadonlyModeStatus Get project read-only mode status Risk: read

await corsair.supabase.api.database.getProjectReadonlyModeStatus({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectSslEnforcementConfig

database.getProjectSslEnforcementConfig Get project SSL enforcement config Risk: read

await corsair.supabase.api.database.getProjectSslEnforcementConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectSupavisorConfig

database.getProjectSupavisorConfig Get project Supavisor config Risk: read

await corsair.supabase.api.database.getProjectSupavisorConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getSqlSnippet

database.getSqlSnippet Get a SQL snippet Risk: read

await corsair.supabase.api.database.getSqlSnippet({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getTableSchemas

database.getTableSchemas Get database table schemas Risk: read

await corsair.supabase.api.database.getTableSchemas({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listBackups

database.listBackups List project database backups Risk: read

await corsair.supabase.api.database.listBackups({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listMigrationHistory

database.listMigrationHistory List migration history Risk: read

await corsair.supabase.api.database.listMigrationHistory({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listSqlSnippets

database.listSqlSnippets List SQL snippets Risk: read

await corsair.supabase.api.database.listSqlSnippets({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listTables

database.listTables List database tables Risk: read

await corsair.supabase.api.database.listTables({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

patchMigration

database.patchMigration Patch a migration Risk: write

await corsair.supabase.api.database.patchMigration({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	Yes	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

removeReadReplica

database.removeReadReplica Remove a read replica Risk: destructive · Irreversible

await corsair.supabase.api.database.removeReadReplica({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

restorePitrBackup

database.restorePitrBackup Restore database PITR backup Risk: destructive · Irreversible

await corsair.supabase.api.database.restorePitrBackup({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

runReadOnlyQuery

database.runReadOnlyQuery Execute a read-only database query Risk: read

await corsair.supabase.api.database.runReadOnlyQuery({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

runSqlQuery

database.runSqlQuery Execute a project database query Risk: write

await corsair.supabase.api.database.runSqlQuery({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

selectFromTable

database.selectFromTable Select rows from a database table Risk: read

await corsair.supabase.api.database.selectFromTable({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateDatabasePassword

database.updateDatabasePassword Update database password Risk: write

await corsair.supabase.api.database.updateDatabasePassword({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateJitAccessConfig

database.updateJitAccessConfig Update JIT access config Risk: write

await corsair.supabase.api.database.updateJitAccessConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateProjectPostgresConfig

database.updateProjectPostgresConfig Update project postgres config Risk: write

await corsair.supabase.api.database.updateProjectPostgresConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateProjectSupavisorConfig

database.updateProjectSupavisorConfig Update project Supavisor config Risk: write

await corsair.supabase.api.database.updateProjectSupavisorConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateSslEnforcementConfig

database.updateSslEnforcementConfig Update SSL enforcement config Risk: write

await corsair.supabase.api.database.updateSslEnforcementConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

upsertMigration

database.upsertMigration Upsert a migration Risk: write

await corsair.supabase.api.database.upsertMigration({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Domains

activateCustomHostname

domains.activateCustomHostname Activate a configured custom hostname Risk: write

await corsair.supabase.api.domains.activateCustomHostname({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

activateVanitySubdomain

domains.activateVanitySubdomain Activate a vanity subdomain for a project Risk: write

await corsair.supabase.api.domains.activateVanitySubdomain({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

checkVanitySubdomainAvailability

domains.checkVanitySubdomainAvailability Check vanity subdomain availability Risk: read

await corsair.supabase.api.domains.checkVanitySubdomainAvailability({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteCustomHostnameConfig

domains.deleteCustomHostnameConfig Delete custom hostname configuration Risk: destructive · Irreversible

await corsair.supabase.api.domains.deleteCustomHostnameConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteProjectVanitySubdomain

domains.deleteProjectVanitySubdomain Delete a project vanity subdomain Risk: destructive · Irreversible

await corsair.supabase.api.domains.deleteProjectVanitySubdomain({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectCustomHostnameConfig

domains.getProjectCustomHostnameConfig Get a project custom hostname configuration Risk: read

await corsair.supabase.api.domains.getProjectCustomHostnameConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getVanitySubdomainConfig

domains.getVanitySubdomainConfig Get current vanity subdomain config Risk: read

await corsair.supabase.api.domains.getVanitySubdomainConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateProjectCustomHostname

domains.updateProjectCustomHostname Update project custom hostname Risk: write

await corsair.supabase.api.domains.updateProjectCustomHostname({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

verifyCustomHostnameDns

domains.verifyCustomHostnameDns Reverify custom hostname DNS Risk: write

await corsair.supabase.api.domains.verifyCustomHostnameDns({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Edge Functions

createFunction

edgeFunctions.createFunction Create an Edge Function Risk: write

await corsair.supabase.api.edgeFunctions.createFunction({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteFunction

edgeFunctions.deleteFunction Delete an Edge Function Risk: destructive · Irreversible

await corsair.supabase.api.edgeFunctions.deleteFunction({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	Yes	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deployFunction

edgeFunctions.deployFunction Deploy an Edge Function Risk: write

await corsair.supabase.api.edgeFunctions.deployFunction({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getFunction

edgeFunctions.getFunction Retrieve an Edge Function Risk: read

await corsair.supabase.api.edgeFunctions.getFunction({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	Yes	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getFunctionBody

edgeFunctions.getFunctionBody Retrieve an Edge Function body Risk: read

await corsair.supabase.api.edgeFunctions.getFunctionBody({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	Yes	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

invokeEdgeFunction

edgeFunctions.invokeEdgeFunction Invoke an Edge Function Risk: write

await corsair.supabase.api.edgeFunctions.invokeEdgeFunction({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	Yes	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listFunctions

edgeFunctions.listFunctions List Edge Functions Risk: read

await corsair.supabase.api.edgeFunctions.listFunctions({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateFunction

edgeFunctions.updateFunction Update an Edge Function Risk: write

await corsair.supabase.api.edgeFunctions.updateFunction({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	Yes	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateFunctions

edgeFunctions.updateFunctions Bulk update Edge Functions Risk: write

await corsair.supabase.api.edgeFunctions.updateFunctions({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Environments

countActionRuns

environments.countActionRuns Count action runs Risk: read

await corsair.supabase.api.environments.countActionRuns({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

createDatabaseBranch

environments.createDatabaseBranch Create a database branch Risk: write

await corsair.supabase.api.environments.createDatabaseBranch({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteDatabaseBranch

environments.deleteDatabaseBranch Delete a database branch Risk: destructive · Irreversible

await corsair.supabase.api.environments.deleteDatabaseBranch({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	Yes	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

disablePreviewBranching

environments.disablePreviewBranching Disable preview branching Risk: write

await corsair.supabase.api.environments.disablePreviewBranching({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getActionRun

environments.getActionRun Get action run status Risk: read

await corsair.supabase.api.environments.getActionRun({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	Yes	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getActionRunLogs

environments.getActionRunLogs Get action run logs Risk: read

await corsair.supabase.api.environments.getActionRunLogs({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	Yes	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getBranch

environments.getBranch Get a database branch by name Risk: read

await corsair.supabase.api.environments.getBranch({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	Yes	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getDatabaseBranchConfig

environments.getDatabaseBranchConfig Get database branch config Risk: read

await corsair.supabase.api.environments.getDatabaseBranchConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	Yes	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listDatabaseBranches

environments.listDatabaseBranches List database branches Risk: read

await corsair.supabase.api.environments.listDatabaseBranches({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

pushBranch

environments.pushBranch Push a database branch Risk: write

await corsair.supabase.api.environments.pushBranch({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	Yes	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

resetDatabaseBranch

environments.resetDatabaseBranch Reset a database branch Risk: destructive · Irreversible

await corsair.supabase.api.environments.resetDatabaseBranch({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	Yes	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateDatabaseBranchConfig

environments.updateDatabaseBranchConfig Update database branch config Risk: write

await corsair.supabase.api.environments.updateDatabaseBranchConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	Yes	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Oauth

authorizeUserThroughOauth

oauth.authorizeUserThroughOauth Generate a Supabase OAuth authorization URL Risk: read

await corsair.supabase.api.oauth.authorizeUserThroughOauth({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

exchangeOauthToken

oauth.exchangeOauthToken Exchange an OAuth authorization code or refresh token Risk: write

await corsair.supabase.api.oauth.exchangeOauthToken({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Organizations

createOrganization

organizations.createOrganization Create an organization Risk: write

await corsair.supabase.api.organizations.createOrganization({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getOrganization

organizations.getOrganization Get organization information Risk: read

await corsair.supabase.api.organizations.getOrganization({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	Yes	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listAllOrganizations

organizations.listAllOrganizations List organizations Risk: read

await corsair.supabase.api.organizations.listAllOrganizations({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listOrganizationMembers

organizations.listOrganizationMembers List organization members Risk: read

await corsair.supabase.api.organizations.listOrganizationMembers({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	Yes	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Projects

createProject

projects.createProject Create a project Risk: write

await corsair.supabase.api.projects.createProject({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteProject

projects.deleteProject Delete a project Risk: destructive · Irreversible

await corsair.supabase.api.projects.deleteProject({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getAvailableRegions

projects.getAvailableRegions Get available project regions Risk: read

await corsair.supabase.api.projects.getAvailableRegions({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getHealth

projects.getHealth Get project API health status Risk: read

await corsair.supabase.api.projects.getHealth({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProject

projects.getProject Get a project Risk: read

await corsair.supabase.api.projects.getProject({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectNetworkBans

projects.getProjectNetworkBans Retrieve project network bans Risk: read

await corsair.supabase.api.projects.getProjectNetworkBans({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectNetworkRestrictions

projects.getProjectNetworkRestrictions Get project network restrictions Risk: read

await corsair.supabase.api.projects.getProjectNetworkRestrictions({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectServiceHealthStatus

projects.getProjectServiceHealthStatus Get project service health status Risk: read

await corsair.supabase.api.projects.getProjectServiceHealthStatus({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectUpgradeEligibility

projects.getProjectUpgradeEligibility Get project upgrade eligibility Risk: read

await corsair.supabase.api.projects.getProjectUpgradeEligibility({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectUpgradeStatus

projects.getProjectUpgradeStatus Get project upgrade status Risk: read

await corsair.supabase.api.projects.getProjectUpgradeStatus({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listAllProjects

projects.listAllProjects List projects Risk: read

await corsair.supabase.api.projects.listAllProjects({});

Input

Name	Type	Required	Description
`ref`	`string`	No	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

patchNetworkRestrictions

projects.patchNetworkRestrictions Patch project network restrictions Risk: write

await corsair.supabase.api.projects.patchNetworkRestrictions({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

removeNetworkBans

projects.removeNetworkBans Remove project network bans Risk: write

await corsair.supabase.api.projects.removeNetworkBans({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateProject

projects.updateProject Update a project Risk: write

await corsair.supabase.api.projects.updateProject({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateProjectNetworkRestrictions

projects.updateProjectNetworkRestrictions Apply project network restrictions Risk: write

await corsair.supabase.api.projects.updateProjectNetworkRestrictions({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

upgradeProjectPostgresVersion

projects.upgradeProjectPostgresVersion Upgrade project PostgreSQL version Risk: write

await corsair.supabase.api.projects.upgradeProjectPostgresVersion({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Rest

getProjectPostgrestConfig

rest.getProjectPostgrestConfig Get project PostgREST config Risk: read

await corsair.supabase.api.rest.getProjectPostgrestConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateProjectPostgrestConfig

rest.updateProjectPostgrestConfig Update project PostgREST config Risk: write

await corsair.supabase.api.rest.updateProjectPostgrestConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Secrets

createApiKey

secrets.createApiKey Create a project API key Risk: write

await corsair.supabase.api.secrets.createApiKey({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

createBulkSecrets

secrets.createBulkSecrets Create multiple project secrets Risk: write

await corsair.supabase.api.secrets.createBulkSecrets({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteApiKey

secrets.deleteApiKey Delete a project API key Risk: destructive · Irreversible

await corsair.supabase.api.secrets.deleteApiKey({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

deleteSecrets

secrets.deleteSecrets Delete multiple project secrets Risk: destructive · Irreversible

await corsair.supabase.api.secrets.deleteSecrets({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectApiKey

secrets.getProjectApiKey Get a project API key Risk: read

await corsair.supabase.api.secrets.getProjectApiKey({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectApiKeys

secrets.getProjectApiKeys Get project API keys Risk: read

await corsair.supabase.api.secrets.getProjectApiKeys({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectLegacyApiKeys

secrets.getProjectLegacyApiKeys Get project legacy API keys status Risk: read

await corsair.supabase.api.secrets.getProjectLegacyApiKeys({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getProjectPgsodiumConfig

secrets.getProjectPgsodiumConfig Get project pgsodium config Risk: read

await corsair.supabase.api.secrets.getProjectPgsodiumConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listSecrets

secrets.listSecrets List project secrets Risk: read

await corsair.supabase.api.secrets.listSecrets({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateApiKey

secrets.updateApiKey Update a project API key Risk: write

await corsair.supabase.api.secrets.updateApiKey({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	Yes	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updatePgsodiumConfig

secrets.updatePgsodiumConfig Update pgsodium root key Risk: destructive

await corsair.supabase.api.secrets.updatePgsodiumConfig({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

updateProjectLegacyApiKeys

secrets.updateProjectLegacyApiKeys Update project legacy API keys Risk: write

await corsair.supabase.api.secrets.updateProjectLegacyApiKeys({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

Storage

getResumableUploadBaseOptions

storage.getResumableUploadBaseOptions Get TUS resumable upload base options Risk: read

await corsair.supabase.api.storage.getResumableUploadBaseOptions({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

getResumableUploadOptions

storage.getResumableUploadOptions Get TUS resumable upload options Risk: read

await corsair.supabase.api.storage.getResumableUploadOptions({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	Yes	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

handleResumableUploadSignOptions

storage.handleResumableUploadSignOptions Handle TUS resumable upload sign options Risk: read

await corsair.supabase.api.storage.handleResumableUploadSignOptions({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

handleResumableUploadSignOptionsWithId

storage.handleResumableUploadSignOptionsWithId Handle TUS resumable upload sign options with ID Risk: read

await corsair.supabase.api.storage.handleResumableUploadSignOptionsWithId({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	Yes	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any

listBuckets

storage.listBuckets List storage buckets Risk: read

await corsair.supabase.api.storage.listBuckets({});

Input

Name	Type	Required	Description
`ref`	`string`	Yes	—
`id`	`string`	No	—
`slug`	`string`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`runId`	`string`	No	—
`tpaId`	`string`	No	—
`providerId`	`string`	No	—
`branchId`	`string`	No	—
`functionSlug`	`string`	No	—
`uploadId`	`string`	No	—
`schema`	`string`	No	—
`table`	`string`	No	—
`columns`	`string[]`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—
`body`	`any`	No	—
`query`	`Record<string, any>`	No	—
`headers`	`Record<string, string>`	No	—
`mediaType`	`string`	No	—
`baseUrl`	`string`	No	—
`projectApiKey`	`string`	No	—

Output: any