API - Corsair

Every neon.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

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

Api Keys

createApiKey

apiKeys.createApiKey Create API key Risk: write

await corsair.neon.api.apiKeys.createApiKey({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listApiKeys

apiKeys.listApiKeys List API keys Risk: read

await corsair.neon.api.apiKeys.listApiKeys({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

revokeApiKey

apiKeys.revokeApiKey Revoke API key Risk: destructive · Irreversible

await corsair.neon.api.apiKeys.revokeApiKey({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	Yes	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Auth

createBranchNeonAuthNewUser

auth.createBranchNeonAuthNewUser Create new auth user Risk: write

await corsair.neon.api.auth.createBranchNeonAuthNewUser({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

createNeonAuth

auth.createNeonAuth Enable Neon Auth for the branch Risk: write

await corsair.neon.api.auth.createNeonAuth({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

createNeonAuthProviderSDKKeys

auth.createNeonAuthProviderSDKKeys Create Auth Provider SDK keys Risk: write

await corsair.neon.api.auth.createNeonAuthProviderSDKKeys({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteBranchNeonAuthOauthProvider

auth.deleteBranchNeonAuthOauthProvider Delete OAuth provider Risk: destructive

await corsair.neon.api.auth.deleteBranchNeonAuthOauthProvider({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	Yes	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteBranchNeonAuthTrustedDomain

auth.deleteBranchNeonAuthTrustedDomain Delete domain from redirect_uri whitelist Risk: destructive

await corsair.neon.api.auth.deleteBranchNeonAuthTrustedDomain({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteBranchNeonAuthUser

auth.deleteBranchNeonAuthUser Delete auth user Risk: destructive · Irreversible

await corsair.neon.api.auth.deleteBranchNeonAuthUser({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	Yes	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteNeonAuthDomainFromRedirectURIWhitelist

auth.deleteNeonAuthDomainFromRedirectURIWhitelist Delete trusted redirect URI domain (deprecated project-level route) Risk: destructive

await corsair.neon.api.auth.deleteNeonAuthDomainFromRedirectURIWhitelist({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

disableNeonAuth

auth.disableNeonAuth Disable Neon Auth for the branch Risk: destructive

await corsair.neon.api.auth.disableNeonAuth({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getAuthDetails

auth.getAuthDetails Retrieve details about the current API credentials Risk: read

await corsair.neon.api.auth.getAuthDetails({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getNeonAuthAllowLocalhost

auth.getNeonAuthAllowLocalhost Retrieve localhost allow setting Risk: read

await corsair.neon.api.auth.getNeonAuthAllowLocalhost({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getNeonAuthEmailProvider

auth.getNeonAuthEmailProvider Retrieve email provider configuration Risk: read

await corsair.neon.api.auth.getNeonAuthEmailProvider({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listBranchNeonAuthOauthProviders

auth.listBranchNeonAuthOauthProviders List OAuth providers for the branch Risk: read

await corsair.neon.api.auth.listBranchNeonAuthOauthProviders({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listBranchNeonAuthTrustedDomains

auth.listBranchNeonAuthTrustedDomains List domains in redirect_uri whitelist Risk: read

await corsair.neon.api.auth.listBranchNeonAuthTrustedDomains({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listNeonAuthOauthProviders

auth.listNeonAuthOauthProviders List OAuth providers (deprecated project-level route) Risk: read

await corsair.neon.api.auth.listNeonAuthOauthProviders({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

sendNeonAuthTestEmail

auth.sendNeonAuthTestEmail Send test email Risk: write

await corsair.neon.api.auth.sendNeonAuthTestEmail({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateNeonAuthAllowLocalhost

auth.updateNeonAuthAllowLocalhost Update localhost allow setting Risk: write

await corsair.neon.api.auth.updateNeonAuthAllowLocalhost({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateNeonAuthEmailProvider

auth.updateNeonAuthEmailProvider Update email provider configuration Risk: write

await corsair.neon.api.auth.updateNeonAuthEmailProvider({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateNeonAuthOauthProvider

auth.updateNeonAuthOauthProvider Update OAuth provider (deprecated project-level route) Risk: write

await corsair.neon.api.auth.updateNeonAuthOauthProvider({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	Yes	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Branches

countProjectBranches

branches.countProjectBranches Retrieve number of branches Risk: read

await corsair.neon.api.branches.countProjectBranches({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

createProjectBranch

branches.createProjectBranch Create branch Risk: write

await corsair.neon.api.branches.createProjectBranch({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

createProjectBranchAnonymized

branches.createProjectBranchAnonymized Create anonymized branch Risk: write

await corsair.neon.api.branches.createProjectBranchAnonymized({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteProjectBranch

branches.deleteProjectBranch Delete branch Risk: destructive

await corsair.neon.api.branches.deleteProjectBranch({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

finalizeRestoreBranch

branches.finalizeRestoreBranch Finalize branch restore from snapshot Risk: write

await corsair.neon.api.branches.finalizeRestoreBranch({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getAnonymizedBranchStatus

branches.getAnonymizedBranchStatus Retrieve anonymized branch status Risk: read

await corsair.neon.api.branches.getAnonymizedBranchStatus({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getMaskingRules

branches.getMaskingRules Retrieve masking rules Risk: read

await corsair.neon.api.branches.getMaskingRules({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectBranch

branches.getProjectBranch Retrieve branch details Risk: read

await corsair.neon.api.branches.getProjectBranch({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectBranchSchema

branches.getProjectBranchSchema Retrieve database schema Risk: read

await corsair.neon.api.branches.getProjectBranchSchema({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectBranchSchemaComparison

branches.getProjectBranchSchemaComparison Compare database schema Risk: read

await corsair.neon.api.branches.getProjectBranchSchemaComparison({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listProjectBranchEndpoints

branches.listProjectBranchEndpoints List compute endpoints for the branch Risk: read

await corsair.neon.api.branches.listProjectBranchEndpoints({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listProjectBranches

branches.listProjectBranches List branches Risk: read

await corsair.neon.api.branches.listProjectBranches({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

restoreProjectBranch

branches.restoreProjectBranch Restore branch to a historical state Risk: write

await corsair.neon.api.branches.restoreProjectBranch({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

setDefaultProjectBranch

branches.setDefaultProjectBranch Set branch as default Risk: write

await corsair.neon.api.branches.setDefaultProjectBranch({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

startAnonymization

branches.startAnonymization Start anonymization Risk: write

await corsair.neon.api.branches.startAnonymization({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateMaskingRules

branches.updateMaskingRules Update masking rules Risk: write

await corsair.neon.api.branches.updateMaskingRules({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateProjectBranch

branches.updateProjectBranch Update branch Risk: write

await corsair.neon.api.branches.updateProjectBranch({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Compute Endpoints

createProjectEndpoint

computeEndpoints.createProjectEndpoint Create compute endpoint Risk: write

await corsair.neon.api.computeEndpoints.createProjectEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteProjectEndpoint

computeEndpoints.deleteProjectEndpoint Delete compute endpoint Risk: destructive

await corsair.neon.api.computeEndpoints.deleteProjectEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	Yes	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectEndpoint

computeEndpoints.getProjectEndpoint Retrieve compute endpoint details Risk: read

await corsair.neon.api.computeEndpoints.getProjectEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	Yes	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listProjectEndpoints

computeEndpoints.listProjectEndpoints List compute endpoints Risk: read

await corsair.neon.api.computeEndpoints.listProjectEndpoints({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

restartProjectEndpoint

computeEndpoints.restartProjectEndpoint Restart compute endpoint Risk: write

await corsair.neon.api.computeEndpoints.restartProjectEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	Yes	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

startProjectEndpoint

computeEndpoints.startProjectEndpoint Start compute endpoint Risk: write

await corsair.neon.api.computeEndpoints.startProjectEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	Yes	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

suspendProjectEndpoint

computeEndpoints.suspendProjectEndpoint Suspend compute endpoint Risk: write

await corsair.neon.api.computeEndpoints.suspendProjectEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	Yes	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateProjectEndpoint

computeEndpoints.updateProjectEndpoint Update compute endpoint Risk: write

await corsair.neon.api.computeEndpoints.updateProjectEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	Yes	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Consumption

getConsumptionHistoryPerAccount

consumption.getConsumptionHistoryPerAccount Retrieve account consumption metrics (legacy, deprecated) Risk: read

await corsair.neon.api.consumption.getConsumptionHistoryPerAccount({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getConsumptionHistoryPerProject

consumption.getConsumptionHistoryPerProject Retrieve project consumption metrics (legacy plans) Risk: read

await corsair.neon.api.consumption.getConsumptionHistoryPerProject({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Data Api

createProjectBranchDataAPI

dataApi.createProjectBranchDataAPI Create Neon Data API Risk: write

await corsair.neon.api.dataApi.createProjectBranchDataAPI({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	Yes	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteProjectBranchDataAPI

dataApi.deleteProjectBranchDataAPI Delete Neon Data API Risk: destructive

await corsair.neon.api.dataApi.deleteProjectBranchDataAPI({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	Yes	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectBranchDataAPI

dataApi.getProjectBranchDataAPI Retrieve Neon Data API configuration Risk: read

await corsair.neon.api.dataApi.getProjectBranchDataAPI({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	Yes	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateProjectBranchDataAPI

dataApi.updateProjectBranchDataAPI Update Neon Data API Risk: write

await corsair.neon.api.dataApi.updateProjectBranchDataAPI({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	Yes	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Databases

createProjectBranchDatabase

databases.createProjectBranchDatabase Create database Risk: write

await corsair.neon.api.databases.createProjectBranchDatabase({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteProjectBranchDatabase

databases.deleteProjectBranchDatabase Delete database Risk: destructive

await corsair.neon.api.databases.deleteProjectBranchDatabase({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	Yes	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectBranchDatabase

databases.getProjectBranchDatabase Retrieve database details Risk: read

await corsair.neon.api.databases.getProjectBranchDatabase({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	Yes	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listProjectBranchDatabases

databases.listProjectBranchDatabases List databases Risk: read

await corsair.neon.api.databases.listProjectBranchDatabases({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateProjectBranchDatabase

databases.updateProjectBranchDatabase Update database Risk: write

await corsair.neon.api.databases.updateProjectBranchDatabase({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	Yes	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Organizations

createOrganizationInvitations

organizations.createOrganizationInvitations Create organization invitations Risk: write

await corsair.neon.api.organizations.createOrganizationInvitations({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

createOrgApiKey

organizations.createOrgApiKey Create organization API key Risk: write

await corsair.neon.api.organizations.createOrgApiKey({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getOrganization

organizations.getOrganization Retrieve organization details Risk: read

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

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getOrganizationInvitations

organizations.getOrganizationInvitations List organization invitations Risk: read

await corsair.neon.api.organizations.getOrganizationInvitations({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getOrganizationMember

organizations.getOrganizationMember Retrieve organization member details Risk: read

await corsair.neon.api.organizations.getOrganizationMember({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	Yes	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getOrganizationMembers

organizations.getOrganizationMembers List organization members Risk: read

await corsair.neon.api.organizations.getOrganizationMembers({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listOrgApiKeys

organizations.listOrgApiKeys List organization API keys Risk: read

await corsair.neon.api.organizations.listOrgApiKeys({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

removeOrganizationMember

organizations.removeOrganizationMember Remove organization member Risk: destructive

await corsair.neon.api.organizations.removeOrganizationMember({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	Yes	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

revokeOrgApiKey

organizations.revokeOrgApiKey Revoke organization API key Risk: destructive · Irreversible

await corsair.neon.api.organizations.revokeOrgApiKey({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	Yes	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

transferProjectsFromOrgToOrg

organizations.transferProjectsFromOrgToOrg Transfer projects between organizations Risk: write

await corsair.neon.api.organizations.transferProjectsFromOrgToOrg({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	Yes	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

transferProjectsFromUserToOrg

organizations.transferProjectsFromUserToOrg Transfer projects from personal account to organization (deprecated) Risk: write

await corsair.neon.api.organizations.transferProjectsFromUserToOrg({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateOrganizationMember

organizations.updateOrganizationMember Update role for organization member Risk: write

await corsair.neon.api.organizations.updateOrganizationMember({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	Yes	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Projects

acceptProjectTransferRequest

projects.acceptProjectTransferRequest Accept a project transfer request Risk: write

await corsair.neon.api.projects.acceptProjectTransferRequest({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	Yes	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

addProjectJWKS

projects.addProjectJWKS Add JWKS URL Risk: write

await corsair.neon.api.projects.addProjectJWKS({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

createProject

projects.createProject Create project Risk: write

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

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

createProjectTransferRequest

projects.createProjectTransferRequest Create a project transfer request Risk: write

await corsair.neon.api.projects.createProjectTransferRequest({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteProject

projects.deleteProject Delete project Risk: destructive · Irreversible

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

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteProjectJWKS

projects.deleteProjectJWKS Delete JWKS URL Risk: destructive

await corsair.neon.api.projects.deleteProjectJWKS({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	Yes	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getAvailablePreloadLibraries

projects.getAvailablePreloadLibraries List available shared preload libraries Risk: read

await corsair.neon.api.projects.getAvailablePreloadLibraries({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getConnectionURI

projects.getConnectionURI Retrieve database connection URI Risk: read

await corsair.neon.api.projects.getConnectionURI({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProject

projects.getProject Retrieve project details Risk: read

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

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectJWKS

projects.getProjectJWKS List JWKS URLs Risk: read

await corsair.neon.api.projects.getProjectJWKS({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectOperation

projects.getProjectOperation Retrieve operation details Risk: read

await corsair.neon.api.projects.getProjectOperation({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	Yes	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

grantPermissionToProject

projects.grantPermissionToProject Grant project access Risk: write

await corsair.neon.api.projects.grantPermissionToProject({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listProjectOperations

projects.listProjectOperations List operations Risk: read

await corsair.neon.api.projects.listProjectOperations({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listProjectPermissions

projects.listProjectPermissions List project access Risk: read

await corsair.neon.api.projects.listProjectPermissions({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listProjects

projects.listProjects List projects Risk: read

await corsair.neon.api.projects.listProjects({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listSharedProjects

projects.listSharedProjects List shared projects Risk: read

await corsair.neon.api.projects.listSharedProjects({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

revokePermissionFromProject

projects.revokePermissionFromProject Revoke project access Risk: destructive

await corsair.neon.api.projects.revokePermissionFromProject({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	Yes	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateProject

projects.updateProject Update project Risk: write

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

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Regions

getActiveRegions

regions.getActiveRegions List supported regions Risk: read

await corsair.neon.api.regions.getActiveRegions({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Roles

createProjectBranchRole

roles.createProjectBranchRole Create role Risk: write

await corsair.neon.api.roles.createProjectBranchRole({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteProjectBranchRole

roles.deleteProjectBranchRole Delete role Risk: destructive

await corsair.neon.api.roles.deleteProjectBranchRole({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	Yes	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectBranchRole

roles.getProjectBranchRole Retrieve role details Risk: read

await corsair.neon.api.roles.getProjectBranchRole({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	Yes	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getProjectBranchRolePassword

roles.getProjectBranchRolePassword Retrieve role password Risk: read

await corsair.neon.api.roles.getProjectBranchRolePassword({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	Yes	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listProjectBranchRoles

roles.listProjectBranchRoles List roles Risk: read

await corsair.neon.api.roles.listProjectBranchRoles({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

resetProjectBranchRolePassword

roles.resetProjectBranchRolePassword Reset role password Risk: write

await corsair.neon.api.roles.resetProjectBranchRolePassword({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	Yes	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Snapshots

createSnapshot

snapshots.createSnapshot Create snapshot Risk: write

await corsair.neon.api.snapshots.createSnapshot({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteSnapshot

snapshots.deleteSnapshot Delete snapshot Risk: destructive · Irreversible

await corsair.neon.api.snapshots.deleteSnapshot({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	Yes	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getSnapshotSchedule

snapshots.getSnapshotSchedule Retrieve backup schedule Risk: read

await corsair.neon.api.snapshots.getSnapshotSchedule({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	Yes	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listSnapshots

snapshots.listSnapshots List project snapshots Risk: read

await corsair.neon.api.snapshots.listSnapshots({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

restoreSnapshot

snapshots.restoreSnapshot Restore snapshot Risk: write

await corsair.neon.api.snapshots.restoreSnapshot({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	Yes	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

updateSnapshot

snapshots.updateSnapshot Update snapshot Risk: write

await corsair.neon.api.snapshots.updateSnapshot({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	Yes	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Users

getCurrentUserInfo

users.getCurrentUserInfo Retrieve current user details Risk: read

await corsair.neon.api.users.getCurrentUserInfo({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getCurrentUserOrganizations

users.getCurrentUserOrganizations List organizations for the current user Risk: read

await corsair.neon.api.users.getCurrentUserOrganizations({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Vpc

assignOrganizationVPCEndpoint

vpc.assignOrganizationVPCEndpoint Assign or update VPC endpoint Risk: write

await corsair.neon.api.vpc.assignOrganizationVPCEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	Yes	—
`vpc_endpoint_id`	`string`	Yes	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

assignProjectVPCEndpoint

vpc.assignProjectVPCEndpoint Set VPC endpoint restriction Risk: write

await corsair.neon.api.vpc.assignProjectVPCEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	Yes	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteOrganizationVPCEndpoint

vpc.deleteOrganizationVPCEndpoint Delete VPC endpoint Risk: destructive · Irreversible

await corsair.neon.api.vpc.deleteOrganizationVPCEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	Yes	—
`vpc_endpoint_id`	`string`	Yes	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

deleteProjectVPCEndpoint

vpc.deleteProjectVPCEndpoint Delete VPC endpoint restriction Risk: destructive

await corsair.neon.api.vpc.deleteProjectVPCEndpoint({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	Yes	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

getOrganizationVPCEndpointDetails

vpc.getOrganizationVPCEndpointDetails Retrieve VPC endpoint details Risk: read

await corsair.neon.api.vpc.getOrganizationVPCEndpointDetails({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	Yes	—
`vpc_endpoint_id`	`string`	Yes	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listOrganizationVPCEndpoints

vpc.listOrganizationVPCEndpoints List VPC endpoints Risk: read

await corsair.neon.api.vpc.listOrganizationVPCEndpoints({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	Yes	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listOrganizationVPCEndpointsAllRegions

vpc.listOrganizationVPCEndpointsAllRegions List VPC endpoints across all regions Risk: read

await corsair.neon.api.vpc.listOrganizationVPCEndpointsAllRegions({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	Yes	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

listProjectVPCEndpoints

vpc.listProjectVPCEndpoints List VPC endpoint restrictions Risk: read

await corsair.neon.api.vpc.listProjectVPCEndpoints({});

Input

Name	Type	Required	Description
`project_id`	`string`	Yes	—
`branch_id`	`string`	No	—
`database_name`	`string`	No	—
`role_name`	`string`	No	—
`endpoint_id`	`string`	No	—
`operation_id`	`string`	No	—
`permission_id`	`string`	No	—
`request_id`	`string`	No	—
`jwks_id`	`string`	No	—
`key_id`	`string`	No	—
`org_id`	`string`	No	—
`member_id`	`string`	No	—
`oauth_provider_id`	`string`	No	—
`auth_user_id`	`string`	No	—
`source_org_id`	`string`	No	—
`region_id`	`string`	No	—
`vpc_endpoint_id`	`string`	No	—
`snapshot_id`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—
`baseUrl`	`string`	No	—

query full type

{
}

headers full type

{
}

Output: any

Overview

Database

​Api Keys

​createApiKey

​listApiKeys

​revokeApiKey

​Auth

​createBranchNeonAuthNewUser

​createNeonAuth

​createNeonAuthProviderSDKKeys

​deleteBranchNeonAuthOauthProvider

​deleteBranchNeonAuthTrustedDomain

​deleteBranchNeonAuthUser

​deleteNeonAuthDomainFromRedirectURIWhitelist

​disableNeonAuth

​getAuthDetails

​getNeonAuthAllowLocalhost

​getNeonAuthEmailProvider

​listBranchNeonAuthOauthProviders

​listBranchNeonAuthTrustedDomains

​listNeonAuthOauthProviders

​sendNeonAuthTestEmail

​updateNeonAuthAllowLocalhost

​updateNeonAuthEmailProvider

​updateNeonAuthOauthProvider

​Branches

​countProjectBranches

​createProjectBranch

​createProjectBranchAnonymized

​deleteProjectBranch

​finalizeRestoreBranch

​getAnonymizedBranchStatus

​getMaskingRules

​getProjectBranch

​getProjectBranchSchema

​getProjectBranchSchemaComparison

​listProjectBranchEndpoints

​listProjectBranches

​restoreProjectBranch

​setDefaultProjectBranch

​startAnonymization

​updateMaskingRules

​updateProjectBranch

​Compute Endpoints

​createProjectEndpoint

​deleteProjectEndpoint

​getProjectEndpoint

​listProjectEndpoints

​restartProjectEndpoint

​startProjectEndpoint

​suspendProjectEndpoint

​updateProjectEndpoint

​Consumption

​getConsumptionHistoryPerAccount

​getConsumptionHistoryPerProject

​Data Api

​createProjectBranchDataAPI

​deleteProjectBranchDataAPI

​getProjectBranchDataAPI

​updateProjectBranchDataAPI

​Databases

​createProjectBranchDatabase

​deleteProjectBranchDatabase

​getProjectBranchDatabase

​listProjectBranchDatabases

​updateProjectBranchDatabase

​Organizations

​createOrganizationInvitations

​createOrgApiKey

​getOrganization

​getOrganizationInvitations

​getOrganizationMember

​getOrganizationMembers

​listOrgApiKeys

​removeOrganizationMember

​revokeOrgApiKey

​transferProjectsFromOrgToOrg

​transferProjectsFromUserToOrg

​updateOrganizationMember

​Projects

​acceptProjectTransferRequest

​addProjectJWKS

Api Keys

createApiKey

listApiKeys

revokeApiKey

Auth

createBranchNeonAuthNewUser

createNeonAuth

createNeonAuthProviderSDKKeys

deleteBranchNeonAuthOauthProvider

deleteBranchNeonAuthTrustedDomain

deleteBranchNeonAuthUser

deleteNeonAuthDomainFromRedirectURIWhitelist

disableNeonAuth

getAuthDetails

getNeonAuthAllowLocalhost

getNeonAuthEmailProvider

listBranchNeonAuthOauthProviders

listBranchNeonAuthTrustedDomains

listNeonAuthOauthProviders

sendNeonAuthTestEmail

updateNeonAuthAllowLocalhost

updateNeonAuthEmailProvider

updateNeonAuthOauthProvider

Branches

countProjectBranches

createProjectBranch

createProjectBranchAnonymized

deleteProjectBranch

finalizeRestoreBranch

getAnonymizedBranchStatus

getMaskingRules

getProjectBranch

getProjectBranchSchema

getProjectBranchSchemaComparison

listProjectBranchEndpoints

listProjectBranches

restoreProjectBranch

setDefaultProjectBranch

startAnonymization

updateMaskingRules

updateProjectBranch

Compute Endpoints

createProjectEndpoint

deleteProjectEndpoint

getProjectEndpoint

listProjectEndpoints

restartProjectEndpoint

startProjectEndpoint

suspendProjectEndpoint

updateProjectEndpoint

Consumption

getConsumptionHistoryPerAccount

getConsumptionHistoryPerProject

Data Api

createProjectBranchDataAPI

deleteProjectBranchDataAPI

getProjectBranchDataAPI

updateProjectBranchDataAPI

Databases

createProjectBranchDatabase

deleteProjectBranchDatabase

getProjectBranchDatabase

listProjectBranchDatabases

updateProjectBranchDatabase

Organizations

createOrganizationInvitations

createOrgApiKey

getOrganization

getOrganizationInvitations

getOrganizationMember

getOrganizationMembers

listOrgApiKeys

removeOrganizationMember

revokeOrgApiKey

transferProjectsFromOrgToOrg

transferProjectsFromUserToOrg

updateOrganizationMember

Projects

acceptProjectTransferRequest

addProjectJWKS