Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

Add generation for v2 APIs. (#48983)

Ivan Vasilov628c7e08d6b0
diff --git a/packages/api-types/index.ts b/packages/api-types/index.ts
index 4870d902de6..9c89e97947a 100644
--- a/packages/api-types/index.ts
+++ b/packages/api-types/index.ts
@@ -1,25 +1,38 @@
import type {
- components as apiComponents,
- operations as apiOperations,
- paths as apiPaths,
-} from './types/api'
+ components as apiV1Components,
+ operations as apiV1Operations,
+ paths as apiV1Paths,
+} from './types/api-v1'
+import type {
+ components as apiV2Components,
+ operations as apiV2Operations,
+ paths as apiV2Paths,
+} from './types/api-v2'
import type {
components as platformComponents,
operations as platformOperations,
paths as platformPaths,
} from './types/platform'
-export type { webhooks, $defs } from './types/api'
+export type { webhooks, $defs } from './types/api-v2'
-export interface paths extends apiPaths, platformPaths {}
-export interface operations extends apiOperations, platformOperations {}
+export interface paths extends apiV2Paths, apiV1Paths, platformPaths {}
+export interface operations extends apiV2Operations, apiV1Operations, platformOperations {}
export interface components {
- schemas: apiComponents['schemas'] & platformComponents['schemas']
- responses: apiComponents['responses'] & platformComponents['responses']
- parameters: apiComponents['parameters'] & platformComponents['parameters']
- requestBodies: apiComponents['requestBodies'] & platformComponents['requestBodies']
- headers: apiComponents['headers'] & platformComponents['headers']
- pathItems: apiComponents['pathItems'] & platformComponents['pathItems']
+ schemas: apiV2Components['schemas'] & apiV1Components['schemas'] & platformComponents['schemas']
+ responses: apiV2Components['responses'] &
+ apiV1Components['responses'] &
+ platformComponents['responses']
+ parameters: apiV2Components['parameters'] &
+ apiV1Components['parameters'] &
+ platformComponents['parameters']
+ requestBodies: apiV2Components['requestBodies'] &
+ apiV1Components['requestBodies'] &
+ platformComponents['requestBodies']
+ headers: apiV2Components['headers'] & apiV1Components['headers'] & platformComponents['headers']
+ pathItems: apiV2Components['pathItems'] &
+ apiV1Components['pathItems'] &
+ platformComponents['pathItems']
}
-export type { platformComponents, apiComponents }
+export type { platformComponents, apiV1Components, apiV2Components }
diff --git a/packages/api-types/redocly.yaml b/packages/api-types/redocly.yaml
index 59023bf6afc..1d34a034cef 100644
--- a/packages/api-types/redocly.yaml
+++ b/packages/api-types/redocly.yaml
@@ -1,9 +1,13 @@
apis:
- api:
+ api-v2:
+ root: http://localhost:8080/api/v2-json
+ x-openapi-ts:
+ output: ./types/api-v2.d.ts
+ api-v1:
root: http://localhost:8080/api/v1-json
x-openapi-ts:
- output: ./types/api.d.ts
+ output: ./types/api-v1.d.ts
platform:
root: http://localhost:8080/api/platform-json
x-openapi-ts:
- output: ./types/platform.d.ts
\ No newline at end of file
+ output: ./types/platform.d.ts
diff --git a/packages/api-types/types/api.d.ts b/packages/api-types/types/api-v1.d.ts
similarity index 100%
rename from packages/api-types/types/api.d.ts
rename to packages/api-types/types/api-v1.d.ts
diff --git a/packages/api-types/types/api-v2.d.ts b/packages/api-types/types/api-v2.d.ts
new file mode 100644
index 00000000000..0824bc203aa
--- /dev/null
+++ b/packages/api-types/types/api-v2.d.ts
@@ -0,0 +1,12062 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+ '/v1/webhooks/events': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * Publish event
+ * @description Ingests and schedules a new webhook event to be published out to all subscribed endpoints.
+ *
+ * In case of non-successful response status codes, early termination, networking issues,
+ * requests to this endpoint should be retried until it succeeds, otherwise there is a risk of
+ * loosing events.
+ *
+ * `meta.idempotency_key` is used to ensure idempotency when retrying the requests and so it
+ * must always be provided.
+ */
+ post: operations['postV1WebhooksEvents']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/integrations/github/connections': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * List GitHub connections of an organization
+ * @description Returns a cursor-paginated list of the GitHub connections of the organization's projects.
+ *
+ * Use `page[after]` and `page[before]` to navigate pages and `page[size]` to control the page size.
+ * Paging walks the organization projects, so a page holds at most `page[size]` connections and can hold fewer (or none) when some of its projects are not connected.
+ * Follow `links.next` until it is `null` rather than stopping on a short page.
+ *
+ * Use `filter[project_ref]` to narrow the list down to a single project.
+ */
+ get: operations['v2-list-organization-github-connections']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/members': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * List members of an organization
+ * @description Returns a cursor-paginated list of organization members including their roles and project-scoped permissions.
+ */
+ get: operations['v2-list-organization-members']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/members/{user_id}/roles': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ /**
+ * Assign or change an organization member role
+ * @description Assigns an org-wide role when projects is omitted, or creates a project-scoped assignment when projects is provided. Uses an org-level role template id from GET /v2/organizations/{slug}/roles. Stale role assignments are automatically cleaned up: if a role no longer has any projects, it is deleted; overlapping project assignments in other roles are automatically removed to avoid duplication.
+ */
+ patch: operations['v2-assign-organization-member-role']
+ trace?: never
+ }
+ '/v2/organizations/{slug}/members/invitations': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * Creates organization invitations
+ * @description Creates member invitations for an organization. Each invitation can have different role and project scope settings.
+ */
+ post: operations['v2-create-organization-invitations']
+ /**
+ * Deletes organization invitations by email
+ * @description Bulk delete member invitations for an organization by email address.
+ */
+ delete: operations['v2-delete-organization-invitations']
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/projects': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * List projects of an organization
+ * @description Returns a cursor-paginated list of projects for the specified organization, including their databases.
+ *
+ * Use `page[after]` and `page[before]` to navigate pages and `page[size]` to control the number of projects returned per page.
+ */
+ get: operations['v2-list-organization-projects']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/roles': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * List roles of an organization
+ * @description Returns a list of org-level roles for the organization.
+ */
+ get: operations['v2-list-organization-roles']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/webhooks/deliveries/{id}': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * Get delivery
+ * @description Get details of a specific delivery attempt.
+ */
+ get: operations['allV2OrganizationsBySlugWebhooks']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/webhooks/deliveries/{id}/retry': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * Retry delivery
+ * @description Retry delivering the same event again.
+ *
+ * Automatic retries are not applicable to manual retries - if the delivery fails, there won't be any automatic retries attempted.
+ *
+ * This endpoint is heavy rate-limited to allow for 10 request within 60 seconds.
+ */
+ post: operations['allV2OrganizationsBySlugWebhooks']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/webhooks/endpoints': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * List endpoints
+ * @description List all Webhook endpoints based on a project's ref or an organization's slug.
+ */
+ get: operations['allV2OrganizationsBySlugWebhooks']
+ put?: never
+ /**
+ * Create endpoint
+ * @description Create new endpoint configuration to subscribe to specific webhook events.
+ */
+ post: operations['allV2OrganizationsBySlugWebhooks']
+ /**
+ * Delete all endpoints
+ * @description Delete all endpoints including all events and deliveries.
+ *
+ * Any in-flight webhooks will result in a no-op.
+ */
+ delete: operations['allV2OrganizationsBySlugWebhooks']
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/webhooks/endpoints/{id}': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * Get endpoint
+ * @description Get details of a specific endpoint.
+ */
+ get: operations['allV2OrganizationsBySlugWebhooks']
+ put?: never
+ post?: never
+ /**
+ * Delete endpoint
+ * @description Delete the endpoint including all events and deliveries
+ *
+ * Any in-flight webhooks will result in a no-op.
+ */
+ delete: operations['allV2OrganizationsBySlugWebhooks']
+ options?: never
+ head?: never
+ /**
+ * Update endpoint
+ * @description Update endpoint's configuration.
+ */
+ patch: operations['allV2OrganizationsBySlugWebhooks']
+ trace?: never
+ }
+ '/v2/organizations/{slug}/webhooks/endpoints/{id}/deliveries': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * List deliveries
+ * @description List all deliveries for a specific endpoint in descending order (newest first).
+ *
+ * Deliveries which has expired are no longer available and will not be listed.
+ */
+ get: operations['allV2OrganizationsBySlugWebhooks']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/organizations/{slug}/webhooks/endpoints/{id}/test': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * Send test event
+ * @description Ingests and schedules a test webhook event to be published out this endpoints.
+ *
+ * Which event type to use can be specified in the request body, otherwise
+ * it will use any matching type the endpoint is listening for.
+ *
+ * The event will contain `is_test: true` in it's payload.
+ *
+ * This endpoint is heavy rate-limited to allow for 10 request within 60 seconds.
+ */
+ post: operations['allV2OrganizationsBySlugWebhooks']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/analytics/log-drains': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /** List project log drains */
+ get: operations['v2-list-log-drains']
+ put?: never
+ /** Create a log drain for a project */
+ post: operations['v2-create-log-drain']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/analytics/log-drains/{id}': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ /** Update a project log drain */
+ put: operations['v2-update-log-drain']
+ post?: never
+ /** Delete a project log drain */
+ delete: operations['v2-delete-log-drain']
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/config': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * [Alpha] Get a project's service configuration
+ * @description Returns the project's database, pooler, Auth, Data API, Realtime and Storage configuration — the same configuration a branch inherits from its base project. Each is the effective config, so a setting the project has never overridden is reported at its platform default rather than as null. Auth secrets are returned as an HMAC of their value. `storage` is read live from the storage service; the rest come from this platform's own records.
+ */
+ get: operations['v2-get-project-config']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/private-link/associations': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /** List AWS accounts attached to the project PrivateLink share */
+ get: operations['v2-list-private-link-associations']
+ put?: never
+ /**
+ * Add an AWS account to the project PrivateLink share
+ * @description Adds an AWS account to the project's PrivateLink configuration and schedules the AWS resources to be created.
+ */
+ post: operations['v2-create-private-link-association']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/private-link/associations/aws-account/{aws_account_id}': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ post?: never
+ /**
+ * Remove an AWS account from the project PrivateLink share
+ * @description Removes an AWS account from the project's PrivateLink configuration (targeting the primary database). Cleans up the associated AWS resources.
+ */
+ delete: operations['v2-delete-private-link-association']
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/private-link/associations/aws-account/{aws_account_id}/database/{database_identifier}': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ post?: never
+ /**
+ * Remove an AWS account from a specific database PrivateLink share
+ * @description Removes an AWS account from the project's PrivateLink configuration for the given read replica. Cleans up the associated AWS resources.
+ */
+ delete: operations['v2-delete-private-link-association-for-database']
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/transfers': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /** Transfers a project to a different organization */
+ post: operations['v2-transfer-a-project']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/transfers/previews': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /** Previews transferring a project to a different organizations, shows eligibility and impact */
+ post: operations['v2-preview-a-project-transfer']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/webhooks/deliveries/{id}': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * Get delivery
+ * @description Get details of a specific delivery attempt.
+ */
+ get: operations['allV2ProjectsByRefWebhooks']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/webhooks/deliveries/{id}/retry': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * Retry delivery
+ * @description Retry delivering the same event again.
+ *
+ * Automatic retries are not applicable to manual retries - if the delivery fails, there won't be any automatic retries attempted.
+ *
+ * This endpoint is heavy rate-limited to allow for 10 request within 60 seconds.
+ */
+ post: operations['allV2ProjectsByRefWebhooks']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/webhooks/endpoints': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * List endpoints
+ * @description List all Webhook endpoints based on a project's ref or an organization's slug.
+ */
+ get: operations['allV2ProjectsByRefWebhooks']
+ put?: never
+ /**
+ * Create endpoint
+ * @description Create new endpoint configuration to subscribe to specific webhook events.
+ */
+ post: operations['allV2ProjectsByRefWebhooks']
+ /**
+ * Delete all endpoints
+ * @description Delete all endpoints including all events and deliveries.
+ *
+ * Any in-flight webhooks will result in a no-op.
+ */
+ delete: operations['allV2ProjectsByRefWebhooks']
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/webhooks/endpoints/{id}': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * Get endpoint
+ * @description Get details of a specific endpoint.
+ */
+ get: operations['allV2ProjectsByRefWebhooks']
+ put?: never
+ post?: never
+ /**
+ * Delete endpoint
+ * @description Delete the endpoint including all events and deliveries
+ *
+ * Any in-flight webhooks will result in a no-op.
+ */
+ delete: operations['allV2ProjectsByRefWebhooks']
+ options?: never
+ head?: never
+ /**
+ * Update endpoint
+ * @description Update endpoint's configuration.
+ */
+ patch: operations['allV2ProjectsByRefWebhooks']
+ trace?: never
+ }
+ '/v2/projects/{ref}/webhooks/endpoints/{id}/deliveries': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * List deliveries
+ * @description List all deliveries for a specific endpoint in descending order (newest first).
+ *
+ * Deliveries which has expired are no longer available and will not be listed.
+ */
+ get: operations['allV2ProjectsByRefWebhooks']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/webhooks/endpoints/{id}/test': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * Send test event
+ * @description Ingests and schedules a test webhook event to be published out this endpoints.
+ *
+ * Which event type to use can be specified in the request body, otherwise
+ * it will use any matching type the endpoint is listening for.
+ *
+ * The event will contain `is_test: true` in it's payload.
+ *
+ * This endpoint is heavy rate-limited to allow for 10 request within 60 seconds.
+ */
+ post: operations['allV2ProjectsByRefWebhooks']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/workers': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * [Alpha] List all workers
+ * @description Returns all workers you've previously deployed to the specified project.
+ */
+ get: operations['v2-list-all-workers']
+ put?: never
+ post?: never
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/workers/{name}': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ /**
+ * [Alpha] Retrieve a worker
+ * @description Returns a worker along with its instance tally. Poll this after a deploy until `build_state` leaves `building`.
+ */
+ get: operations['v2-get-a-worker']
+ put?: never
+ post?: never
+ /**
+ * [Alpha] Delete a worker
+ * @description Tombstones the worker. Its instances and image are torn down asynchronously.
+ */
+ delete: operations['v2-delete-a-worker']
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/workers/{name}/deploy': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * [Alpha] Deploy a worker
+ * @description Creates the worker if it does not exist, building from a context staged through the uploads endpoint. The build runs asynchronously: this answers 202 and the worker reaches `build_state` `active` or `failed` later.
+ */
+ post: operations['v2-deploy-a-worker']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+ '/v2/projects/{ref}/workers/{name}/uploads': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * [Alpha] Mint a presigned slot for a build-context upload
+ * @description PUT the `.tar.gz` build context to the returned `url` before `expires_at`, then deploy with the upload id as `context_upload_id`. The bytes go straight to storage — no management API request carries them.
+ */
+ post: operations['v2-create-worker-upload']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
+}
+export type webhooks = Record<string, never>
+export interface components {
+ schemas: {
+ APIErrorObject: {
+ code: string
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ message: string
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ CreateLogDrainRequestOpenApi: {
+ data: {
+ attributes: {
+ /** @enum {string} */
+ backend_type:
+ | 'postgres'
+ | 'bigquery'
+ | 'clickhouse'
+ | 'webhook'
+ | 'datadog'
+ | 'loki'
+ | 'sentry'
+ | 's3'
+ | 'axiom'
+ | 'last9'
+ | 'otlp'
+ | 'syslog'
+ config:
+ | {
+ hostname?: string
+ password?: string | null
+ port?: number | null
+ schema?: string
+ url?: string | null
+ username?: string | null
+ }
+ | {
+ gzip?: boolean
+ headers?: {
+ [key: string]: string
+ }
+ /** @enum {string} */
+ http?: 'http1' | 'http2'
+ url?: string
+ }
+ | {
+ dataset_id?: string
+ project_id?: string
+ }
+ | {
+ api_key?: string
+ region?: string
+ }
+ | {
+ headers?: {
+ [key: string]: string
+ }
+ password?: string | null
+ url?: string
+ username?: string | null
+ }
+ | {
+ dsn?: string
+ }
+ | {
+ api_token?: string
+ dataset_name?: string
+ domain?: string
+ }
+ | {
+ ca_cert?: string
+ cipher_key?: string
+ client_cert?: string
+ client_key?: string
+ host?: string
+ port?: number
+ structured_data?: string
+ /** @default false */
+ tls?: boolean
+ }
+ description?: string
+ name: string
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'log_drain'
+ }
+ }
+ ErrorResponseBody: {
+ error: components['schemas']['ErrorResponseBodyAPIErrorObject']
+ }
+ ErrorResponseBodyAPIErrorObject: {
+ code: string
+ description?: string
+ id?: string
+ issues?: components['schemas']['ErrorResponseBodyAPIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ message: string
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ ListLogDrainsResponse: {
+ data: {
+ attributes: {
+ /** @enum {string} */
+ backend_type:
+ | 'postgres'
+ | 'bigquery'
+ | 'clickhouse'
+ | 'webhook'
+ | 'datadog'
+ | 'loki'
+ | 'sentry'
+ | 's3'
+ | 'axiom'
+ | 'last9'
+ | 'otlp'
+ | 'syslog'
+ config:
+ | {
+ hostname?: string
+ password?: string | null
+ port?: number | null
+ schema?: string
+ url?: string | null
+ username?: string | null
+ }
+ | {
+ gzip?: boolean
+ headers?: {
+ [key: string]: string
+ }
+ /** @enum {string} */
+ http?: 'http1' | 'http2'
+ url?: string
+ }
+ | {
+ dataset_id?: string
+ project_id?: string
+ }
+ | {
+ api_key?: string
+ region?: string
+ }
+ | {
+ headers?: {
+ [key: string]: string
+ }
+ password?: string | null
+ url?: string
+ username?: string | null
+ }
+ | {
+ dsn?: string
+ }
+ | {
+ api_token?: string
+ dataset_name?: string
+ domain?: string
+ }
+ | {
+ ca_cert?: string
+ cipher_key?: string
+ client_cert?: string
+ client_key?: string
+ host?: string
+ port?: number
+ structured_data?: string
+ /** @default false */
+ tls?: boolean
+ }
+ description?: string
+ name: string
+ }
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'log_drain'
+ }[]
+ }
+ LogDrainResponse: {
+ data: {
+ attributes: {
+ /** @enum {string} */
+ backend_type:
+ | 'postgres'
+ | 'bigquery'
+ | 'clickhouse'
+ | 'webhook'
+ | 'datadog'
+ | 'loki'
+ | 'sentry'
+ | 's3'
+ | 'axiom'
+ | 'last9'
+ | 'otlp'
+ | 'syslog'
+ config:
+ | {
+ hostname?: string
+ password?: string | null
+ port?: number | null
+ schema?: string
+ url?: string | null
+ username?: string | null
+ }
+ | {
+ gzip?: boolean
+ headers?: {
+ [key: string]: string
+ }
+ /** @enum {string} */
+ http?: 'http1' | 'http2'
+ url?: string
+ }
+ | {
+ dataset_id?: string
+ project_id?: string
+ }
+ | {
+ api_key?: string
+ region?: string
+ }
+ | {
+ headers?: {
+ [key: string]: string
+ }
+ password?: string | null
+ url?: string
+ username?: string | null
+ }
+ | {
+ dsn?: string
+ }
+ | {
+ api_token?: string
+ dataset_name?: string
+ domain?: string
+ }
+ | {
+ ca_cert?: string
+ cipher_key?: string
+ client_cert?: string
+ client_key?: string
+ host?: string
+ port?: number
+ structured_data?: string
+ /** @default false */
+ tls?: boolean
+ }
+ description?: string
+ name: string
+ }
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'log_drain'
+ }
+ }
+ OrganizationMemberRoleResponse: {
+ data: {
+ attributes: {
+ /**
+ * @description Role name. For project-scoped assignments this is the base role name.
+ * @example developer
+ */
+ name: string
+ /** @description Project refs this role is scoped to. Empty array for org-level roles. */
+ projects: {
+ name: string
+ ref: string
+ }[]
+ /**
+ * @description Whether this role applies org-wide or is scoped to specific projects for the user.
+ * @enum {string}
+ */
+ scope: 'organization' | 'project'
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'organization_member_role'
+ }
+ }
+ UpdateLogDrainRequestOpenApi: {
+ data: {
+ attributes: {
+ /** @enum {string} */
+ backend_type:
+ | 'postgres'
+ | 'bigquery'
+ | 'clickhouse'
+ | 'webhook'
+ | 'datadog'
+ | 'loki'
+ | 'sentry'
+ | 's3'
+ | 'axiom'
+ | 'last9'
+ | 'otlp'
+ | 'syslog'
+ config?:
+ | {
+ hostname?: string
+ password?: string | null
+ port?: number | null
+ schema?: string
+ url?: string | null
+ username?: string | null
+ }
+ | {
+ gzip?: boolean
+ headers?: {
+ [key: string]: string
+ }
+ /** @enum {string} */
+ http?: 'http1' | 'http2'
+ url?: string
+ }
+ | {
+ dataset_id?: string
+ project_id?: string
+ }
+ | {
+ api_key?: string
+ region?: string
+ }
+ | {
+ headers?: {
+ [key: string]: string
+ }
+ password?: string | null
+ url?: string
+ username?: string | null
+ }
+ | {
+ dsn?: string
+ }
+ | {
+ api_token?: string
+ dataset_name?: string
+ domain?: string
+ }
+ | {
+ ca_cert?: string
+ cipher_key?: string
+ client_cert?: string
+ client_key?: string
+ host?: string
+ port?: number
+ structured_data?: string
+ /** @default false */
+ tls?: boolean
+ }
+ description?: string
+ name?: string
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'log_drain'
+ }
+ }
+ V2AssignOrganizationMemberRoleRequest: {
+ data: {
+ attributes: {
+ /** @description The projects to assign a project-scoped role for. If omitted, assigns an org-wide role. */
+ projects?: {
+ /**
+ * @description Project ref
+ * @example abcjuqabhgwjjutfvtpa
+ */
+ ref: string
+ }[]
+ /**
+ * @description Role name to assign. Must be one of: owner, administrator, developer, read-only. Must be on a Team or Enterprise plan to use the read-only role.
+ * @example developer
+ * @enum {string}
+ */
+ role: 'owner' | 'administrator' | 'developer' | 'read-only'
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'organization_member_role'
+ }
+ }
+ V2CreateInvitationsRequest: {
+ data: {
+ attributes: {
+ /** Format: email */
+ email: string
+ /** @description The projects to limit a user to. If omitted, user will have org-wide access with the provided role. */
+ projects?: {
+ /**
+ * @description Project ref
+ * @example abcjuqabhgwjjutfvtpa
+ */
+ ref: string
+ }[]
+ require_sso?: boolean
+ /**
+ * @description Role name to assign. Must be on a Team or Enterprise plan to use the read-only role.
+ * @example developer
+ * @enum {string}
+ */
+ role: 'owner' | 'administrator' | 'developer' | 'read-only'
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'organization_invitation'
+ }[]
+ }
+ V2CreateInvitationsResponse: {
+ data: {
+ attributes: {
+ /** Format: email */
+ email: string
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'organization_invitation'
+ }[]
+ error?: {
+ code: string
+ description?: string
+ id?: string
+ issues?: {
+ code: string
+ description?: string
+ id?: string
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ message: string
+ meta: {
+ /** Format: email */
+ email: string
+ }
+ }[]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ message: string
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ }
+ V2CreatePrivateLinkAssociationRequest: {
+ data: {
+ attributes: {
+ /** @description Optional human-readable name for the AWS account. */
+ account_name?: string
+ /** @description The AWS account ID to add to the project PrivateLink share. */
+ aws_account_id: string
+ /** @description Identifier of the read replica this PrivateLink share should target. Omit to target the primary database. */
+ database_identifier?: string
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'private_link_association'
+ }
+ }
+ V2DeleteInvitationsRequest: {
+ data: {
+ attributes: {
+ /** Format: email */
+ email: string
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'organization_invitation'
+ }[]
+ }
+ V2DeleteInvitationsResponse: {
+ data: {
+ attributes: {
+ /** Format: email */
+ email: string
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'organization_invitation'
+ }[]
+ }
+ V2DeployWorkerRequest: {
+ data: {
+ attributes: {
+ /** @description Id of a build context staged through the uploads endpoint. Required unless `runtime` is set. */
+ context_upload_id?: string
+ spec: {
+ backend?: string
+ /** @example public */
+ exposure: string
+ /** @example 1 */
+ instances: number
+ /** @example node */
+ runtime?: string
+ /** @example 2gb-1vcpu */
+ size: string
+ }
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'project_worker'
+ }
+ }
+ V2ListGitHubConnectionsResponse: {
+ data: {
+ attributes: {
+ /** @description Maximum number of preview branches */
+ branch_limit: number
+ /** @description When the connection was created */
+ inserted_at: string
+ /** @description GitHub App installation id */
+ installation_id: number
+ /** @description Whether a preview branch is created for every pull request */
+ new_branch_per_pr: boolean
+ /** @description The connected Supabase project */
+ project: {
+ id: number
+ name: string
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ ref: string
+ }
+ /** @description The connected GitHub repository */
+ repository: {
+ id: number
+ name: string
+ }
+ /** @description Whether branches are only created for changes under `supabase/` */
+ supabase_changes_only: boolean
+ /** @description When the connection was last updated */
+ updated_at: string
+ /** @description The user who created the connection, if still known */
+ user: {
+ id: number
+ primary_email: string | null
+ username: string
+ } | null
+ /** @description Directory within the repository the project lives in */
+ workdir: string
+ }
+ /**
+ * @description Connection id.
+ * @example 7
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'github_connection'
+ }[]
+ links: {
+ /**
+ * @description URL path to the first page if available.
+ * @example /v2/organizations/my-org/integrations/github/connections?page[size]=10
+ */
+ first?: string | null
+ /**
+ * @description URL path to the last page if available.
+ * @example /v2/organizations/my-org/integrations/github/connections?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295
+ */
+ last?: string | null
+ /**
+ * @description URL path to the next page.
+ * @example /v2/organizations/my-org/integrations/github/connections?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4
+ */
+ next: string | null
+ /**
+ * @description URL path to the previous page.
+ * @example /v2/organizations/my-org/integrations/github/connections?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7
+ */
+ prev: string | null
+ }
+ }
+ V2ListMembersResponse: {
+ data: {
+ attributes: {
+ /** @description Member's avatar URL */
+ avatar_url: string | null
+ /** @description Whether this member is a Single Sign-On user */
+ is_sso_user: boolean
+ /** @description Whether Multi-Factor Authentication is enabled for this member */
+ mfa_enabled: boolean
+ /** @description Member's primary email */
+ primary_email: string | null
+ /** @description Roles assigned to this member. Includes both org-level and project-scoped roles. */
+ roles: {
+ /**
+ * @description Role name. For project-scoped roles this is the base role name.
+ * @example developer
+ */
+ name: string
+ /** @description Project refs this role is scoped to. Empty array for org-level roles. */
+ projects: {
+ name: string
+ ref: string
+ }[]
+ /**
+ * @description Whether this role applies org-wide or is scoped to specific projects for the user.
+ * @enum {string}
+ */
+ scope: 'organization' | 'project'
+ }[]
+ /** @description Member's username */
+ username: string | null
+ }
+ /** Format: uuid */
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'organization_member'
+ }[]
+ links: {
+ /**
+ * @description URL path to the first page if available.
+ * @example /v2/organizations/my-org/members?page[size]=10
+ */
+ first?: string | null
+ /**
+ * @description URL path to the last page if available.
+ * @example /v2/organizations/my-org/members?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295
+ */
+ last?: string | null
+ /**
+ * @description URL path to the next page.
+ * @example /v2/organizations/my-org/members?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4
+ */
+ next: string | null
+ /**
+ * @description URL path to the previous page.
+ * @example /v2/organizations/my-org/members?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7
+ */
+ prev: string | null
+ }
+ }
+ V2ListPrivateLinkAssociationsResponse: {
+ data: {
+ attributes: {
+ /** @description Human-readable name for the AWS account. */
+ account_name?: string
+ /** @description The AWS account ID this PrivateLink share is associated with. */
+ aws_account_id: string
+ /** @description Identifier of the database this PrivateLink share targets - the project ref for the primary, or the read replica identifier. */
+ database_identifier: string
+ /**
+ * @description Whether this PrivateLink share targets the primary database or a read replica.
+ * @enum {string}
+ */
+ database_type: 'PRIMARY' | 'READ_REPLICA'
+ /** @description ARN of the AWS VPC Lattice resource configuration backing this PrivateLink share. */
+ resource_access_manager_resource_config_arn?: string
+ /** @description ID of the AWS VPC Lattice resource configuration backing this PrivateLink share. */
+ resource_access_manager_resource_config_id?: string
+ /** @description ARN of the AWS Resource Access Manager resource share for this association. */
+ resource_access_manager_share_arn?: string
+ /**
+ * Format: date-time
+ * @description The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending.
+ */
+ shared_at: string | null
+ /**
+ * @description
+ * - `CREATING`: The PrivateLink resources and the Association are in the process of being created. The PrivateLink Share cannot be accepted yet.
+ * - `READY`: The PrivateLink resources have been created and the PrivateLink Share can be accepted for the duration of 12h after sharing. See `shared_at`.
+ * - `ASSOCIATION_REQUEST_EXPIRED`: The PrivateLink Share has not been accepted within the 12h time limit. This association can now be deleted.
+ * - `ASSOCIATION_ACCEPTED`: The PrivateLink Share was successfully accepted.
+ * - `CREATION_FAILED`: The PrivateLink resources failed to create. This likely means something went wrong on Supabase's and and support should be contacted.
+ * - `DELETING`: The PrivateLink resources and the Association are in the process of being deleted. The PrivateLink Share cannot be accepted yet.
+ *
+ * @enum {string}
+ */
+ status:
+ | 'CREATING'
+ | 'READY'
+ | 'ASSOCIATION_REQUEST_EXPIRED'
+ | 'ASSOCIATION_ACCEPTED'
+ | 'CREATION_FAILED'
+ | 'DELETING'
+ }
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'private_link_association'
+ }[]
+ }
+ V2ListProjectsResponse: {
+ data: {
+ attributes: {
+ /** @description Cloud provider hosting the project */
+ cloud_provider: string
+ /** @description The project's databases including compute and disk attributes. */
+ databases: {
+ cloud_provider: string
+ disk_last_modified_at?: string
+ disk_throughput_mbps?: number
+ /** @enum {string} */
+ disk_type?: 'gp3' | 'io2'
+ disk_volume_size_gb?: number
+ identifier: string
+ /** @enum {string} */
+ infra_compute_size?:
+ | 'pico'
+ | 'nano'
+ | 'micro'
+ | 'small'
+ | 'medium'
+ | 'large'
+ | 'xlarge'
+ | '2xlarge'
+ | '4xlarge'
+ | '8xlarge'
+ | '12xlarge'
+ | '16xlarge'
+ | '24xlarge'
+ | '24xlarge_optimized_memory'
+ | '24xlarge_optimized_cpu'
+ | '24xlarge_high_memory'
+ | '48xlarge'
+ | '48xlarge_optimized_memory'
+ | '48xlarge_optimized_cpu'
+ | '48xlarge_high_memory'
+ region: string | null
+ /** @enum {string} */
+ status:
+ | 'ACTIVE_HEALTHY'
+ | 'ACTIVE_UNHEALTHY'
+ | 'COMING_UP'
+ | 'GOING_DOWN'
+ | 'INIT_FAILED'
+ | 'REMOVED'
+ | 'RESTORING'
+ | 'UNKNOWN'
+ | 'INIT_READ_REPLICA'
+ | 'INIT_READ_REPLICA_FAILED'
+ | 'RESTARTING'
+ | 'RESIZING'
+ /** @enum {string} */
+ type: 'PRIMARY' | 'READ_REPLICA'
+ }[]
+ /** @description When the project was created */
+ inserted_at: string
+ /** @description Project name */
+ name: string
+ /** @description Region the project is hosted in */
+ region: string
+ /**
+ * @description Project status
+ * @enum {string}
+ */
+ status:
+ | 'INACTIVE'
+ | 'ACTIVE_HEALTHY'
+ | 'ACTIVE_UNHEALTHY'
+ | 'COMING_UP'
+ | 'UNKNOWN'
+ | 'GOING_DOWN'
+ | 'INIT_FAILED'
+ | 'REMOVED'
+ | 'RESTORING'
+ | 'UPGRADING'
+ | 'PAUSING'
+ | 'RESTORE_FAILED'
+ | 'RESTARTING'
+ | 'PAUSE_FAILED'
+ | 'RESIZING'
+ }
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'project'
+ }[]
+ links: {
+ /**
+ * @description URL path to the first page if available.
+ * @example /v2/organizations/my-org/projects?page[size]=10
+ */
+ first?: string | null
+ /**
+ * @description URL path to the last page if available.
+ * @example /v2/organizations/my-org/projects?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295
+ */
+ last?: string | null
+ /**
+ * @description URL path to the next page.
+ * @example /v2/organizations/my-org/projects?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4
+ */
+ next: string | null
+ /**
+ * @description URL path to the previous page.
+ * @example /v2/organizations/my-org/projects?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7
+ */
+ prev: string | null
+ }
+ }
+ V2ListRolesResponse: {
+ data: {
+ attributes: {
+ /**
+ * @description Role name.
+ * @example developer
+ */
+ name: string
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'organization_role'
+ }[]
+ }
+ V2ListWorkersResponse: {
+ data: {
+ attributes: {
+ /** @enum {string} */
+ build_state: 'building' | 'active' | 'failed'
+ deleting?: boolean
+ image_version?: string
+ instances?: {
+ declared: number
+ live: number
+ ready: number
+ stale: number
+ }
+ instances_error?: string
+ secret_generation: string
+ spec: {
+ backend?: string
+ /** @example public */
+ exposure: string
+ /** @example 1 */
+ instances: number
+ /** @example node */
+ runtime?: string
+ /** @example 2gb-1vcpu */
+ size: string
+ }
+ state_reason?: string
+ }
+ /**
+ * @description Worker name.
+ * @example hello-world
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'project_worker'
+ }[]
+ }
+ V2PreviewProjectTransferResponse: {
+ data: {
+ attributes: {
+ errors: {
+ key: string
+ message: string
+ }[]
+ info: {
+ key: string
+ message: string
+ }[]
+ valid: boolean
+ warnings: {
+ key: string
+ message: string
+ }[]
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'project_transfer_result'
+ }
+ }
+ V2PrivateLinkAssociationResponse: {
+ data: {
+ attributes: {
+ /** @description Human-readable name for the AWS account. */
+ account_name?: string
+ /** @description The AWS account ID this PrivateLink share is associated with. */
+ aws_account_id: string
+ /** @description Identifier of the database this PrivateLink share targets - the project ref for the primary, or the read replica identifier. */
+ database_identifier: string
+ /**
+ * @description Whether this PrivateLink share targets the primary database or a read replica.
+ * @enum {string}
+ */
+ database_type: 'PRIMARY' | 'READ_REPLICA'
+ /** @description ARN of the AWS VPC Lattice resource configuration backing this PrivateLink share. */
+ resource_access_manager_resource_config_arn?: string
+ /** @description ID of the AWS VPC Lattice resource configuration backing this PrivateLink share. */
+ resource_access_manager_resource_config_id?: string
+ /** @description ARN of the AWS Resource Access Manager resource share for this association. */
+ resource_access_manager_share_arn?: string
+ /**
+ * Format: date-time
+ * @description The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending.
+ */
+ shared_at: string | null
+ /**
+ * @description
+ * - `CREATING`: The PrivateLink resources and the Association are in the process of being created. The PrivateLink Share cannot be accepted yet.
+ * - `READY`: The PrivateLink resources have been created and the PrivateLink Share can be accepted for the duration of 12h after sharing. See `shared_at`.
+ * - `ASSOCIATION_REQUEST_EXPIRED`: The PrivateLink Share has not been accepted within the 12h time limit. This association can now be deleted.
+ * - `ASSOCIATION_ACCEPTED`: The PrivateLink Share was successfully accepted.
+ * - `CREATION_FAILED`: The PrivateLink resources failed to create. This likely means something went wrong on Supabase's and and support should be contacted.
+ * - `DELETING`: The PrivateLink resources and the Association are in the process of being deleted. The PrivateLink Share cannot be accepted yet.
+ *
+ * @enum {string}
+ */
+ status:
+ | 'CREATING'
+ | 'READY'
+ | 'ASSOCIATION_REQUEST_EXPIRED'
+ | 'ASSOCIATION_ACCEPTED'
+ | 'CREATION_FAILED'
+ | 'DELETING'
+ }
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'private_link_association'
+ }
+ }
+ V2ProjectConfigResponse: {
+ data: {
+ attributes: {
+ api: {
+ db_extra_search_path: string
+ /** @description If `null`, no pool size is written to the project's PostgREST config and PostgREST's own default applies. The platform does not pick a value here. */
+ db_pool: number | null
+ db_pool_acquisition_timeout: number
+ /** @description Schemas exposed through the Data API */
+ db_schema: string
+ max_rows: number
+ }
+ /** @description Effective Auth config, keyed by lowercased GoTrue setting name and resolved through the `gotrue_config` view, so a setting the project has never overridden is reported at its platform default. Secrets are returned as an HMAC of their value, never in plaintext. */
+ auth: {
+ [key: string]: unknown
+ }
+ database: {
+ network_restrictions: {
+ allowed_cidrs: {
+ address: string
+ /** @enum {string} */
+ type: 'v4' | 'v6'
+ }[]
+ applied_at?: string
+ /** @enum {string} */
+ entitlement: 'disallowed' | 'allowed'
+ /**
+ * @description Whether the allowlist below is applied to the project or only stored.
+ * @enum {string}
+ */
+ status: 'stored' | 'applied'
+ updated_at?: string
+ }
+ /** @description Postgres parameter overrides. Empty when the project runs entirely on defaults. */
+ postgres_settings: {
+ /** @description Default unit: s */
+ checkpoint_timeout?: string
+ cron_log_statement?: boolean
+ effective_cache_size?: string
+ hot_standby_feedback?: boolean
+ /** @description Default unit: ms */
+ log_autovacuum_min_duration?: string
+ log_checkpoints?: boolean
+ log_connections?: boolean
+ log_disconnections?: boolean
+ log_duration?: boolean
+ log_lock_waits?: boolean
+ log_recovery_conflict_waits?: boolean
+ log_replication_commands?: boolean
+ /** @description Default unit: ms */
+ log_startup_progress_interval?: string
+ log_temp_files?: string
+ logical_decoding_work_mem?: string
+ maintenance_work_mem?: string
+ max_connections?: number
+ max_locks_per_transaction?: number
+ max_logical_replication_workers?: number
+ max_parallel_maintenance_workers?: number
+ max_parallel_workers?: number
+ max_parallel_workers_per_gather?: number
+ max_replication_slots?: number
+ max_slot_wal_keep_size?: string
+ max_standby_archive_delay?: string
+ max_standby_streaming_delay?: string
+ max_sync_workers_per_subscription?: number
+ max_wal_senders?: number
+ max_wal_size?: string
+ max_worker_processes?: number
+ /** @enum {string} */
+ session_replication_role?: 'origin' | 'replica' | 'local'
+ shared_buffers?: string
+ /** @description Default unit: ms */
+ statement_timeout?: string
+ track_activity_query_size?: string
+ track_commit_timestamp?: boolean
+ wal_keep_size?: string
+ /** @description Default unit: ms */
+ wal_sender_timeout?: string
+ work_mem?: string
+ }
+ /** @description Whether the database rejects plaintext connections */
+ ssl_enforced: boolean
+ }
+ pooler: {
+ /** @description Defaults to the pooler's size for the project's compute when not overridden. */
+ default_pool_size: number
+ ignore_startup_parameters: string
+ /** @description Defaults to the pooler's size for the project's compute when not overridden. */
+ max_client_conn: number
+ /** @enum {string} */
+ pool_mode: 'transaction' | 'session' | 'statement'
+ query_wait_timeout: number
+ reserve_pool_size: number
+ server_idle_timeout: number
+ server_lifetime: number
+ }
+ realtime: {
+ /** @description Defaults to Realtime's pool size for the project's compute when not overridden. */
+ connection_pool: number
+ max_bytes_per_second: number
+ max_channels_per_client: number
+ max_concurrent_users: number
+ max_events_per_second: number
+ max_joins_per_second: number
+ max_payload_size_in_kb: number
+ max_presence_events_per_second: number
+ /** @description If `null`, no override is stored and Realtime applies its own default. */
+ postgres_changes_pool: number | null
+ presence_enabled: boolean
+ private_only: boolean
+ suspend: boolean
+ }
+ /** @description Read from the storage service's admin API rather than the middleware DB, so unlike the rest of this resource it reflects the tenant's live config. */
+ storage: {
+ capabilities: {
+ iceberg_catalog: boolean
+ list_v2: boolean
+ }
+ database_pool_mode: string
+ features: {
+ iceberg_catalog: {
+ enabled: boolean
+ max_catalogs: number
+ max_namespaces: number
+ max_tables: number
+ }
+ image_transformation: {
+ enabled: boolean
+ }
+ purge_cache: {
+ enabled: boolean
+ }
+ s3_protocol: {
+ enabled: boolean
+ }
+ vector_buckets: {
+ enabled: boolean
+ max_buckets: number
+ max_indexes: number
+ }
+ }
+ /** Format: int64 */
+ file_size_limit: number
+ migration_version: string
+ /** @enum {string} */
+ upstream_target: 'main' | 'canary'
+ }
+ }
+ /** @description Project ref. */
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'project_config'
+ }
+ }
+ V2TransferProjectBody: {
+ data: {
+ attributes: {
+ target_organization_slug: string
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'project_transfer_input'
+ }
+ }
+ V2WorkerResponse: {
+ data: {
+ attributes: {
+ /** @enum {string} */
+ build_state: 'building' | 'active' | 'failed'
+ deleting?: boolean
+ image_version?: string
+ instances?: {
+ declared: number
+ live: number
+ ready: number
+ stale: number
+ }
+ instances_error?: string
+ secret_generation: string
+ spec: {
+ backend?: string
+ /** @example public */
+ exposure: string
+ /** @example 1 */
+ instances: number
+ /** @example node */
+ runtime?: string
+ /** @example 2gb-1vcpu */
+ size: string
+ }
+ state_reason?: string
+ }
+ /**
+ * @description Worker name.
+ * @example hello-world
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'project_worker'
+ }
+ }
+ V2WorkerUploadResponse: {
+ data: {
+ attributes: {
+ /** @description When the slot stops accepting the upload. */
+ expires_at: string
+ /** @example PUT */
+ method: string
+ /** @description Presigned destination for the `.tar.gz` build context. */
+ url: string
+ }
+ /**
+ * @description Upload id to pass to the deploy endpoint as `context_upload_id`.
+ * @example cafe0000000000000000000000000000
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'project_worker_upload'
+ }
+ }
+ }
+ responses: never
+ parameters: never
+ requestBodies: never
+ headers: never
+ pathItems: never
+}
+export type $defs = Record<string, never>
+export interface operations {
+ postV1WebhooksEvents: {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * @description Organization slug
+ * @example tsrqponmlkjihgfedcba
+ */
+ organization_slug: string
+ /** @description Extra data to pass to consumers. `organization_slug` and `project_ref` (if applicable) are always provided by default. */
+ payload?: {
+ [key: string]: unknown
+ }
+ /** @description Project's ref. If left unspecified or `null`, the event will published as organization-wide, only to organization-wide endpoints. */
+ project_ref?: string | null
+ /**
+ * Format: date-time
+ * @description Optional timestamp of event publication.
+ */
+ timestamp?: string
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | 'project.v1.paused'
+ | 'project.v1.created'
+ | 'project.v1.restored'
+ | 'project.v1.transferred'
+ | 'project.v1.removed'
+ | 'project.v1.restarted'
+ | 'project.v1.status.changed'
+ | 'project.v1.backup.started'
+ | 'project.v1.branch.created'
+ | 'project.v1.branch.updated'
+ | 'project.v1.branch.removed'
+ | 'organization.v1.member.invitation.created'
+ | 'organization.v1.member.invitation.canceled'
+ | 'organization.v1.member.added'
+ | 'organization.v1.member.removed'
+ | 'organization.v1.member.role.assigned'
+ | 'organization.v1.member.role.removed'
+ | 'organization.v1.member.role.updated'
+ | 'organization.v1.billing.plan.upgraded'
+ | 'organization.v1.billing.plan.downgraded'
+ | 'project.v1.branch.deleted'
+ }
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'event'
+ }
+ meta: {
+ /** @description Idempotency key. */
+ idempotency_key: string
+ }
+ }
+ }
+ }
+ responses: {
+ /** @description Events published */
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'ingress'
+ }
+ }
+ }
+ }
+ /** @description PermissionDenied */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'internal_server_error.event.ingress_failed'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error: Failed to ingress the event'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description TemporarilyDisabled */
+ 503: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'service_unavailable.temporarily_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Service Unavailable: Temporarily disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ 'v2-list-organization-github-connections': {
+ parameters: {
+ query?: {
+ filter?: {
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ project_ref?: string
+ }
+ page?: {
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ after?: string
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ before?: string
+ size?: number
+ }
+ }
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2ListGitHubConnectionsResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-list-organization-members': {
+ parameters: {
+ query?: {
+ filter?: {
+ /** Format: email */
+ primary_email?: string
+ username?: string
+ }
+ page?: {
+ /** Format: uuid */
+ after?: string
+ /** Format: uuid */
+ before?: string
+ size?: number
+ }
+ }
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2ListMembersResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-assign-organization-member-role': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ user_id: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['V2AssignOrganizationMemberRoleRequest']
+ }
+ }
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['OrganizationMemberRoleResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description This feature requires the Enterprise organization plan. */
+ 402: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to assign organization member role */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-create-organization-invitations': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['V2CreateInvitationsRequest']
+ }
+ }
+ responses: {
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2CreateInvitationsResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description This feature requires the Enterprise organization plan. */
+ 402: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-delete-organization-invitations': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['V2DeleteInvitationsRequest']
+ }
+ }
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2DeleteInvitationsResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description This feature requires the Enterprise organization plan. */
+ 402: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-list-organization-projects': {
+ parameters: {
+ query?: {
+ page?: {
+ after?: string
+ before?: string
+ size?: number
+ }
+ /** @description Case-insensitive substring match on the project name. */
+ search?: string
+ /** @description Sort order by creation time: `inserted_at` (oldest first) or `-inserted_at` (newest first). Defaults to `inserted_at`. */
+ sort?: 'inserted_at' | '-inserted_at'
+ }
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2ListProjectsResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-list-organization-roles': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2ListRolesResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of a delivery (UUID v7). */
+ id: string
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Delivery details */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of the attempt.
+ */
+ attempt_timestamp: string
+ event: {
+ /** @description Final data sent to the consumer. */
+ payload: {
+ /**
+ * @description Organization slug
+ * @example tsrqponmlkjihgfedcba
+ */
+ organization_slug: string
+ project_ref: string | null
+ } & {
+ [key: string]: unknown
+ }
+ /**
+ * Format: date-time
+ * @description Timestamp of event publication.
+ */
+ timestamp: string
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | 'project.v1.paused'
+ | 'project.v1.created'
+ | 'project.v1.restored'
+ | 'project.v1.transferred'
+ | 'project.v1.removed'
+ | 'project.v1.restarted'
+ | 'project.v1.status.changed'
+ | 'project.v1.backup.started'
+ | 'project.v1.branch.created'
+ | 'project.v1.branch.updated'
+ | 'project.v1.branch.removed'
+ | 'organization.v1.member.invitation.created'
+ | 'organization.v1.member.invitation.canceled'
+ | 'organization.v1.member.added'
+ | 'organization.v1.member.removed'
+ | 'organization.v1.member.role.assigned'
+ | 'organization.v1.member.role.removed'
+ | 'organization.v1.member.role.updated'
+ | 'organization.v1.billing.plan.upgraded'
+ | 'organization.v1.billing.plan.downgraded'
+ | 'project.v1.branch.deleted'
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of the event, which triggered the delivery (UUID v7).
+ */
+ event_id: string
+ /**
+ * Format: uuid
+ * @description Identifier of a delivery (UUID v7).
+ */
+ id: string
+ response_body:
+ | (
+ | {
+ [key: string]: string
+ }
+ | string
+ )
+ | null
+ /** @description HTTP status code of the response, `0` if unavailable. */
+ response_code: number
+ /** @description HTTP headers of the response, `{}` if unavailable. */
+ response_headers: {
+ [key: string]: string
+ } | null
+ /**
+ * @description Status of the delivery attempt.
+ * @enum {string}
+ */
+ status: 'pending' | 'success' | 'failure' | 'skipped'
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of a delivery (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'delivery'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description DeliveryNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.delivery'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Delivery not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of a delivery (UUID v7). */
+ id: string
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Delivery details */
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'ingress'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description DeliveryNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.delivery'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Delivery not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: {
+ /** @description Up to how many records to return. */
+ 'page[limit]'?: string
+ /** @description Offset for offset-based pagination.
+ *
+ * Offset should be dividable by `page[limit]` without a reminder (`offset % limit === 0`), otherwise it will cause weird behavior when used on a frontend. */
+ 'page[offset]'?: string
+ }
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Collection of endpoints */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }[]
+ links: {
+ /**
+ * @description URL path to the first page if available.
+ * @example /v2/organization/slug/webhooks/endpoints?page[limit]=10&page[offset]=0
+ */
+ first?: string | null
+ /**
+ * @description URL path to the last page if available.
+ * @example /v2/organization/slug/webhooks/endpoints?page[limit]=10&page[offset]=30
+ */
+ last?: string | null
+ /**
+ * @description URL path to the next page.
+ * @example /v2/organization/slug/webhooks/endpoints?page[limit]=10&page[offset]=20
+ */
+ next: string | null
+ /**
+ * @description URL path to the previous page.
+ * @example /v2/organization/slug/webhooks/endpoints?page[limit]=10&page[offset]=0
+ */
+ prev: string | null
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description?: string | null
+ /**
+ * @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events.
+ * @default true
+ */
+ enabled?: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /** @description Secret key to use when signing. All events will be signed according to the [Standard Webhooks](https://www.standardwebhooks.com/) specification. */
+ signing_secret: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ responses: {
+ /** @description Created endpoint */
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Deleted endpoints */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }[]
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Endpoint details */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Deleted endpoint details */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description?: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled?: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types?: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /** @description Secret key to use when signing. All events will be signed according to the [Standard Webhooks](https://www.standardwebhooks.com/) specification. */
+ signing_secret?: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url?: string
+ }
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ responses: {
+ /** @description Updated endpoint details */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: {
+ /** @description Cursor in cursor-based pagination to return up to `page[size]` records after (exclusive) the entry specified by this query param. */
+ 'page[after]'?: string
+ /** @description Cursor in cursor-based pagination to return up to `page[size]` records before (exclusive) the entry specified by this query param. */
+ 'page[before]'?: string
+ /** @description Up to how many records to return. */
+ 'page[size]'?: string
+ }
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description List of deliveries */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of the attempt.
+ */
+ attempt_timestamp: string
+ /**
+ * Format: uuid
+ * @description Identifier of the event, which triggered the delivery (UUID v7).
+ */
+ event_id: string
+ /**
+ * Format: uuid
+ * @description Identifier of a delivery (UUID v7).
+ */
+ id: string
+ response_body:
+ | (
+ | {
+ [key: string]: string
+ }
+ | string
+ )
+ | null
+ /** @description HTTP status code of the response, `0` if unavailable. */
+ response_code: number
+ /** @description HTTP headers of the response, `{}` if unavailable. */
+ response_headers: {
+ [key: string]: string
+ } | null
+ /**
+ * @description Status of the delivery attempt.
+ * @enum {string}
+ */
+ status: 'pending' | 'success' | 'failure' | 'skipped'
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of a delivery (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'delivery'
+ }[]
+ links: {
+ /**
+ * @description URL path to the first page if available.
+ * @example /v2/organizations/slug/webhooks/endpoints/{id}/deliveries?page[size]=10
+ */
+ first?: string | null
+ /**
+ * @description URL path to the last page if available.
+ * @example /v2/organizations/slug/webhooks/endpoints/{id}/deliveries?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295
+ */
+ last?: string | null
+ /**
+ * @description URL path to the next page.
+ * @example /v2/organizations/slug/webhooks/endpoints/{id}/deliveries?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4
+ */
+ next: string | null
+ /**
+ * @description URL path to the previous page.
+ * @example /v2/organizations/slug/webhooks/endpoints/{id}/deliveries?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7
+ */
+ prev: string | null
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2OrganizationsBySlugWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Organization slug */
+ slug: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': {
+ data?: {
+ attributes: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | 'project.v1.paused'
+ | 'project.v1.created'
+ | 'project.v1.restored'
+ | 'project.v1.transferred'
+ | 'project.v1.removed'
+ | 'project.v1.restarted'
+ | 'project.v1.status.changed'
+ | 'project.v1.backup.started'
+ | 'project.v1.branch.created'
+ | 'project.v1.branch.updated'
+ | 'project.v1.branch.removed'
+ | 'organization.v1.member.invitation.created'
+ | 'organization.v1.member.invitation.canceled'
+ | 'organization.v1.member.added'
+ | 'organization.v1.member.removed'
+ | 'organization.v1.member.role.assigned'
+ | 'organization.v1.member.role.removed'
+ | 'organization.v1.member.role.updated'
+ | 'organization.v1.billing.plan.upgraded'
+ | 'organization.v1.billing.plan.downgraded'
+ | 'project.v1.branch.deleted'
+ }
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'event'
+ }
+ }
+ }
+ }
+ responses: {
+ /** @description Event published */
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'ingress'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.endpoint.test.disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Endpoint is disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.endpoint.test.wrong_event_type'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Provided event type is not subscribed to by the endpoint'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ 'v2-list-log-drains': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ListLogDrainsResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to fetch log drains */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-create-log-drain': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['CreateLogDrainRequestOpenApi']
+ }
+ }
+ responses: {
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['LogDrainResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
+ 402: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to create a log drain */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-update-log-drain': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Log drains identifier */
+ id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['UpdateLogDrainRequestOpenApi']
+ }
+ }
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['LogDrainResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to update log drain */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-delete-log-drain': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Log drains identifier */
+ id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 204: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to delete a log drain */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-get-project-config': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2ProjectConfigResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-list-private-link-associations': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2ListPrivateLinkAssociationsResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to retrieve AWS accounts for project */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-create-private-link-association': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['V2CreatePrivateLinkAssociationRequest']
+ }
+ }
+ responses: {
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2PrivateLinkAssociationResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description This feature requires the Team, or Enterprise organization plan. */
+ 402: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to add AWS account to PrivateLink share */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-delete-private-link-association': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description AWS account ID used in PrivateLink association */
+ aws_account_id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 204: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to remove AWS account from PrivateLink share */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-delete-private-link-association-for-database': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description AWS account ID used in PrivateLink association */
+ aws_account_id: string
+ /** @description Identifier of the read replica this PrivateLink association targets */
+ database_identifier: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 204: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to remove AWS account from PrivateLink share */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-transfer-a-project': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['V2TransferProjectBody']
+ }
+ }
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-preview-a-project-transfer': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['V2TransferProjectBody']
+ }
+ }
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2PreviewProjectTransferResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of a delivery (UUID v7). */
+ id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Delivery details */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of the attempt.
+ */
+ attempt_timestamp: string
+ event: {
+ /** @description Final data sent to the consumer. */
+ payload: {
+ /**
+ * @description Organization slug
+ * @example tsrqponmlkjihgfedcba
+ */
+ organization_slug: string
+ project_ref: string | null
+ } & {
+ [key: string]: unknown
+ }
+ /**
+ * Format: date-time
+ * @description Timestamp of event publication.
+ */
+ timestamp: string
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | 'project.v1.paused'
+ | 'project.v1.created'
+ | 'project.v1.restored'
+ | 'project.v1.transferred'
+ | 'project.v1.removed'
+ | 'project.v1.restarted'
+ | 'project.v1.status.changed'
+ | 'project.v1.backup.started'
+ | 'project.v1.branch.created'
+ | 'project.v1.branch.updated'
+ | 'project.v1.branch.removed'
+ | 'organization.v1.member.invitation.created'
+ | 'organization.v1.member.invitation.canceled'
+ | 'organization.v1.member.added'
+ | 'organization.v1.member.removed'
+ | 'organization.v1.member.role.assigned'
+ | 'organization.v1.member.role.removed'
+ | 'organization.v1.member.role.updated'
+ | 'organization.v1.billing.plan.upgraded'
+ | 'organization.v1.billing.plan.downgraded'
+ | 'project.v1.branch.deleted'
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of the event, which triggered the delivery (UUID v7).
+ */
+ event_id: string
+ /**
+ * Format: uuid
+ * @description Identifier of a delivery (UUID v7).
+ */
+ id: string
+ response_body:
+ | (
+ | {
+ [key: string]: string
+ }
+ | string
+ )
+ | null
+ /** @description HTTP status code of the response, `0` if unavailable. */
+ response_code: number
+ /** @description HTTP headers of the response, `{}` if unavailable. */
+ response_headers: {
+ [key: string]: string
+ } | null
+ /**
+ * @description Status of the delivery attempt.
+ * @enum {string}
+ */
+ status: 'pending' | 'success' | 'failure' | 'skipped'
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of a delivery (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'delivery'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description DeliveryNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.delivery'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Delivery not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of a delivery (UUID v7). */
+ id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Delivery details */
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'ingress'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description DeliveryNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.delivery'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Delivery not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: {
+ /** @description Up to how many records to return. */
+ 'page[limit]'?: string
+ /** @description Offset for offset-based pagination.
+ *
+ * Offset should be dividable by `page[limit]` without a reminder (`offset % limit === 0`), otherwise it will cause weird behavior when used on a frontend. */
+ 'page[offset]'?: string
+ }
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Collection of endpoints */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }[]
+ links: {
+ /**
+ * @description URL path to the first page if available.
+ * @example /v2/organization/slug/webhooks/endpoints?page[limit]=10&page[offset]=0
+ */
+ first?: string | null
+ /**
+ * @description URL path to the last page if available.
+ * @example /v2/organization/slug/webhooks/endpoints?page[limit]=10&page[offset]=30
+ */
+ last?: string | null
+ /**
+ * @description URL path to the next page.
+ * @example /v2/organization/slug/webhooks/endpoints?page[limit]=10&page[offset]=20
+ */
+ next: string | null
+ /**
+ * @description URL path to the previous page.
+ * @example /v2/organization/slug/webhooks/endpoints?page[limit]=10&page[offset]=0
+ */
+ prev: string | null
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description?: string | null
+ /**
+ * @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events.
+ * @default true
+ */
+ enabled?: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /** @description Secret key to use when signing. All events will be signed according to the [Standard Webhooks](https://www.standardwebhooks.com/) specification. */
+ signing_secret: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ responses: {
+ /** @description Created endpoint */
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Deleted endpoints */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }[]
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Endpoint details */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Deleted endpoint details */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description?: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled?: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types?: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /** @description Secret key to use when signing. All events will be signed according to the [Standard Webhooks](https://www.standardwebhooks.com/) specification. */
+ signing_secret?: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url?: string
+ }
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ responses: {
+ /** @description Updated endpoint details */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of endpoint's creation.
+ */
+ created_at: string
+ /**
+ * Format: uuid
+ * @description ID of the user who created the endpoint.
+ */
+ created_by: string
+ /**
+ * @description Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.
+ * @example {
+ * "Authorization": "Bearer example_token"
+ * }
+ */
+ custom_headers?: {
+ [key: string]: string
+ } | null
+ /** @description Optional description for the endpoint. */
+ description: string | null
+ /** @description Whether the endpoint is enabled or not - disabled endpoints won't emit any events. */
+ enabled: boolean
+ /**
+ * @description List of subscribed events for which to receive the webhook event.
+ * @example [
+ * {
+ * "type": "v1.project.paused"
+ * }
+ * ]
+ */
+ event_types: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | '*'
+ }[]
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * Format: uri
+ * @description Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.
+ * @example https://mydomain.com/path/to/handler
+ */
+ url: string
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of an endpoint (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'endpoint'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: {
+ /** @description Cursor in cursor-based pagination to return up to `page[size]` records after (exclusive) the entry specified by this query param. */
+ 'page[after]'?: string
+ /** @description Cursor in cursor-based pagination to return up to `page[size]` records before (exclusive) the entry specified by this query param. */
+ 'page[before]'?: string
+ /** @description Up to how many records to return. */
+ 'page[size]'?: string
+ }
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description List of deliveries */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Timestamp of the attempt.
+ */
+ attempt_timestamp: string
+ /**
+ * Format: uuid
+ * @description Identifier of the event, which triggered the delivery (UUID v7).
+ */
+ event_id: string
+ /**
+ * Format: uuid
+ * @description Identifier of a delivery (UUID v7).
+ */
+ id: string
+ response_body:
+ | (
+ | {
+ [key: string]: string
+ }
+ | string
+ )
+ | null
+ /** @description HTTP status code of the response, `0` if unavailable. */
+ response_code: number
+ /** @description HTTP headers of the response, `{}` if unavailable. */
+ response_headers: {
+ [key: string]: string
+ } | null
+ /**
+ * @description Status of the delivery attempt.
+ * @enum {string}
+ */
+ status: 'pending' | 'success' | 'failure' | 'skipped'
+ }
+ /**
+ * Format: uuid
+ * @description Identifier of a delivery (UUID v7).
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'delivery'
+ }[]
+ links: {
+ /**
+ * @description URL path to the first page if available.
+ * @example /v2/organizations/slug/webhooks/endpoints/{id}/deliveries?page[size]=10
+ */
+ first?: string | null
+ /**
+ * @description URL path to the last page if available.
+ * @example /v2/organizations/slug/webhooks/endpoints/{id}/deliveries?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295
+ */
+ last?: string | null
+ /**
+ * @description URL path to the next page.
+ * @example /v2/organizations/slug/webhooks/endpoints/{id}/deliveries?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4
+ */
+ next: string | null
+ /**
+ * @description URL path to the previous page.
+ * @example /v2/organizations/slug/webhooks/endpoints/{id}/deliveries?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7
+ */
+ prev: string | null
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ allV2ProjectsByRefWebhooks: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Identifier of an endpoint (UUID v7). */
+ id: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': {
+ data?: {
+ attributes: {
+ /**
+ * @description Webhook event type.
+ * @enum {string}
+ */
+ type:
+ | 'v1.project.paused'
+ | 'v1.project.created'
+ | 'v1.project.restored'
+ | 'v1.project.transferred'
+ | 'v1.project.removed'
+ | 'v1.project.restarted'
+ | 'v1.project.status.changed'
+ | 'v1.project.backup.started'
+ | 'v1.project.branch.created'
+ | 'v1.project.branch.updated'
+ | 'v1.project.branch.removed'
+ | 'v1.organization.member.invitation.created'
+ | 'v1.organization.member.invitation.canceled'
+ | 'v1.organization.member.added'
+ | 'v1.organization.member.removed'
+ | 'v1.organization.member.role.assigned'
+ | 'v1.organization.member.role.removed'
+ | 'v1.organization.member.role.updated'
+ | 'v1.organization.billing.plan.upgraded'
+ | 'v1.organization.billing.plan.downgraded'
+ | 'project.v1.paused'
+ | 'project.v1.created'
+ | 'project.v1.restored'
+ | 'project.v1.transferred'
+ | 'project.v1.removed'
+ | 'project.v1.restarted'
+ | 'project.v1.status.changed'
+ | 'project.v1.backup.started'
+ | 'project.v1.branch.created'
+ | 'project.v1.branch.updated'
+ | 'project.v1.branch.removed'
+ | 'organization.v1.member.invitation.created'
+ | 'organization.v1.member.invitation.canceled'
+ | 'organization.v1.member.added'
+ | 'organization.v1.member.removed'
+ | 'organization.v1.member.role.assigned'
+ | 'organization.v1.member.role.removed'
+ | 'organization.v1.member.role.updated'
+ | 'organization.v1.billing.plan.upgraded'
+ | 'organization.v1.billing.plan.downgraded'
+ | 'project.v1.branch.deleted'
+ }
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'event'
+ }
+ }
+ }
+ }
+ responses: {
+ /** @description Event published */
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ data: {
+ id: string
+ /**
+ * @description Resource type.
+ * @constant
+ */
+ type: 'ingress'
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'bad_request.endpoint.test.disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Endpoint is disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.endpoint.test.wrong_event_type'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Provided event type is not subscribed to by the endpoint'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_slug'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid organization slug'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'bad_request.invalid_ref'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Bad Request: Invalid project ref'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericUnauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'unauthorized'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Unauthorized'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description Multiple error responses */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error:
+ | {
+ /** @constant */
+ code: 'forbidden.permission_denied'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Permission denied'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ | {
+ /** @constant */
+ code: 'forbidden.access_disabled'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Forbidden: Access disabled'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description EndpointNotFound */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'not_found.endpoint'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Not Found: Endpoint not found'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericRequestTimeout */
+ 408: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'request_timeout'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Request Timeout'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericTooManyRequests */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'too_many_requests'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Too Many Requests'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ /** @description GenericInternalServerError */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': {
+ error: {
+ /** @constant */
+ code: 'internal_server_error'
+ description?: string
+ id?: string
+ issues?: components['schemas']['APIErrorObject'][]
+ links?: {
+ [key: string]: {
+ describedby?: string
+ href: string
+ meta?: {
+ [key: string]: unknown
+ }
+ rel?: string
+ title?: string
+ type?: string
+ }
+ }
+ /** @constant */
+ message: 'Internal Server Error'
+ meta?: {
+ [key: string]: unknown
+ }
+ }
+ $defs: {
+ APIErrorObject: components['schemas']['APIErrorObject']
+ }
+ }
+ }
+ }
+ }
+ }
+ 'v2-list-all-workers': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2ListWorkersResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-get-a-worker': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ name: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2WorkerResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-delete-a-worker': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ name: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 204: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-deploy-a-worker': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ name: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['V2DeployWorkerRequest']
+ }
+ }
+ responses: {
+ 202: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2WorkerResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+ 'v2-create-worker-upload': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ name: string
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2WorkerUploadResponse']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
+}
diff --git a/packages/api-types/types/platform.d.ts b/packages/api-types/types/platform.d.ts
index 7e852900927..5b5b673b495 100644
--- a/packages/api-types/types/platform.d.ts
+++ b/packages/api-types/types/platform.d.ts
@@ -5890,6 +5890,8 @@ export interface components {
| 'vanity_subdomain_write'
| 'platform_webhooks_projects_read'
| 'platform_webhooks_projects_write'
+ | 'workers_read'
+ | 'workers_write'
)[]
}
CreatePlatformAppResponse: {
@@ -5942,6 +5944,7 @@ export interface components {
| 'm7g.medium'
| 'm8g.medium'
| 'm9g.medium'
+ | 'c6g.medium'
| 'm6g.large'
| 'm6a.large'
| 'm6i.large'
@@ -7125,6 +7128,8 @@ export interface components {
| 'vanity_subdomain_write'
| 'platform_webhooks_projects_read'
| 'platform_webhooks_projects_write'
+ | 'workers_read'
+ | 'workers_write'
)[]
project_refs?: string[]
}
@@ -7756,6 +7761,12 @@ export interface components {
* @enum {string}
*/
database_type: 'PRIMARY' | 'READ_REPLICA'
+ /** @description ARN of the AWS VPC Lattice resource configuration backing this PrivateLink share. */
+ resource_access_manager_resource_config_arn?: string
+ /** @description ID of the AWS VPC Lattice resource configuration backing this PrivateLink share. */
+ resource_access_manager_resource_config_id?: string
+ /** @description ARN of the AWS Resource Access Manager resource share for this association. */
+ resource_access_manager_share_arn?: string
/**
* Format: date-time
* @description The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending.
@@ -12525,6 +12536,8 @@ export interface components {
| 'vanity_subdomain_write'
| 'platform_webhooks_projects_read'
| 'platform_webhooks_projects_write'
+ | 'workers_read'
+ | 'workers_write'
)[]
}
UpdatePlatformAppInstallationResponse: {