diff --git a/apps/cli-go/api/v1-openapi.yaml b/apps/cli-go/api/v1-openapi.yaml index d1ac70b88e..d167d14ac6 100644 --- a/apps/cli-go/api/v1-openapi.yaml +++ b/apps/cli-go/api/v1-openapi.yaml @@ -400,7 +400,10 @@ paths: x-oauth-scope: environment:write /v1/branches/{branch_id_or_ref}/diff: get: - description: Diffs the specified database branch + description: |- + Diffs the specified database branch + + This endpoint is currently in its **Beta** stage. operationId: v1-diff-a-branch parameters: - name: branch_id_or_ref @@ -457,18 +460,21 @@ paths: description: Failed to diff database branch security: - bearer: [] - summary: '[Beta] Diffs a database branch' + summary: Diffs a database branch tags: - Environments x-badges: - name: 'OAuth scope: environment:write' position: after + - name: Beta + position: before x-endpoint-owners: - dev-workflows x-fga-permissions: - - branching_development_write - - branching_production_write x-oauth-scope: environment:write + x-scalar-stability: experimental /v1/projects: get: description: Returns a list of all projects you've previously created. @@ -540,6 +546,13 @@ paths: x-oauth-scope: projects:write /v1/projects/available-regions: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-get-available-regions parameters: - name: organization_slug @@ -604,17 +617,18 @@ paths: $ref: '#/components/schemas/RegionsInfo_Output' security: - bearer: [] - summary: >- - [Beta] Gets the list of available regions that can be used for a new - project + summary: Gets the list of available regions that can be used for a new project tags: - Projects x-badges: - name: 'OAuth scope: organizations:read' position: after + - name: Beta + position: before x-endpoint-owners: - infra x-oauth-scope: organizations:read + x-scalar-stability: experimental /v1/organizations: get: description: Returns a list of organizations that you currently belong to. @@ -686,6 +700,13 @@ paths: - - organizations_create /v1/oauth/authorize: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-authorize-user parameters: - name: client_id @@ -777,12 +798,16 @@ paths: description: Forbidden action '429': description: Rate limit exceeded - summary: '[Beta] Authorize user through oauth' + summary: Authorize user through oauth tags: - OAuth + x-badges: + - name: Beta + position: before x-endpoint-owners: - auth - control-plane + x-scalar-stability: experimental /v1/oauth/token: post: description: >- @@ -790,6 +815,9 @@ paths: `urn:ietf:params:oauth:grant-type:jwt-bearer` grant types. The `jwt-bearer` grant type (IDJAG — identity-directed JWT assertion) is in beta and available on Team and Enterprise plans only. + + + This endpoint is currently in its **Beta** stage. operationId: v1-exchange-oauth-token parameters: [] requestBody: @@ -811,14 +839,25 @@ paths: description: Forbidden action '429': description: Rate limit exceeded - summary: '[Beta] Exchange auth code for user''s access and refresh token' + summary: Exchange auth code for user's access and refresh token tags: - OAuth + x-badges: + - name: Beta + position: before x-endpoint-owners: - auth - control-plane + x-scalar-stability: experimental /v1/oauth/revoke: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-revoke-token parameters: [] requestBody: @@ -836,12 +875,16 @@ paths: description: Forbidden action '429': description: Rate limit exceeded - summary: '[Beta] Revoke oauth app authorization and it''s corresponding tokens' + summary: Revoke oauth app authorization and it's corresponding tokens tags: - OAuth + x-badges: + - name: Beta + position: before x-endpoint-owners: - auth - control-plane + x-scalar-stability: experimental /v1/oauth/authorize/project-claim: get: description: >- @@ -1916,6 +1959,13 @@ paths: x-oauth-scope: environment:read /v1/projects/{ref}/custom-hostname: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-get-hostname-config parameters: - name: ref @@ -1945,19 +1995,29 @@ paths: description: Failed to retrieve project's custom hostname config security: - bearer: [] - summary: '[Beta] Gets project''s custom hostname config' + summary: Gets project's custom hostname config tags: - Domains x-badges: - name: 'OAuth scope: domains:read' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - custom_domain_read x-oauth-scope: domains:read + x-scalar-stability: experimental delete: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-Delete hostname config parameters: - name: ref @@ -1991,20 +2051,30 @@ paths: description: Failed to delete project custom hostname configuration security: - bearer: [] - summary: '[Beta] Deletes a project''s custom hostname configuration' + summary: Deletes a project's custom hostname configuration tags: - Domains x-badges: - name: 'OAuth scope: domains:write' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - custom_domain_write x-oauth-scope: domains:write + x-scalar-stability: experimental /v1/projects/{ref}/custom-hostname/initialize: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-update-hostname-config parameters: - name: ref @@ -2040,20 +2110,30 @@ paths: description: Failed to update project custom hostname configuration security: - bearer: [] - summary: '[Beta] Updates project''s custom hostname configuration' + summary: Updates project's custom hostname configuration tags: - Domains x-badges: - name: 'OAuth scope: domains:write' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - custom_domain_write x-oauth-scope: domains:write + x-scalar-stability: experimental /v1/projects/{ref}/custom-hostname/reverify: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-verify-dns-config parameters: - name: ref @@ -2084,21 +2164,31 @@ paths: security: - bearer: [] summary: >- - [Beta] Attempts to verify the DNS configuration for project's custom - hostname configuration + Attempts to verify the DNS configuration for project's custom hostname + configuration tags: - Domains x-badges: - name: 'OAuth scope: domains:write' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - custom_domain_write x-oauth-scope: domains:write + x-scalar-stability: experimental /v1/projects/{ref}/custom-hostname/activate: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-activate-custom-hostname parameters: - name: ref @@ -2128,20 +2218,30 @@ paths: description: Failed to activate project custom hostname configuration security: - bearer: [] - summary: '[Beta] Activates a custom hostname for a project.' + summary: Activates a custom hostname for a project. tags: - Domains x-badges: - name: 'OAuth scope: domains:write' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - custom_domain_write x-oauth-scope: domains:write + x-scalar-stability: experimental /v1/projects/{ref}/jit-access: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-get-jit-access-config parameters: - name: ref @@ -2198,19 +2298,29 @@ paths: description: Failed to retrieve project's temporary access configuration. security: - bearer: [] - summary: '[Beta] Get project''s temporary access configuration.' + summary: Get project's temporary access configuration. tags: - Database x-badges: - name: 'OAuth scope: database:read' position: after + - name: Beta + position: before x-endpoint-owners: - security - control-plane x-fga-permissions: - - project_admin_read x-oauth-scope: database:read + x-scalar-stability: experimental put: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-update-jit-access-config parameters: - name: ref @@ -2273,20 +2383,30 @@ paths: description: Failed to update project's temporary access configuration. security: - bearer: [] - summary: '[Beta] Update project''s temporary access configuration.' + summary: Update project's temporary access configuration. tags: - Database x-badges: - name: 'OAuth scope: database:write' position: after + - name: Beta + position: before x-endpoint-owners: - security - control-plane x-fga-permissions: - - project_admin_write x-oauth-scope: database:write + x-scalar-stability: experimental /v1/projects/{ref}/network-bans/retrieve: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-list-all-network-bans parameters: - name: ref @@ -2316,20 +2436,30 @@ paths: description: Failed to retrieve project's network bans security: - bearer: [] - summary: '[Beta] Gets project''s network bans' + summary: Gets project's network bans tags: - Projects x-badges: - name: 'OAuth scope: projects:read' position: after + - name: Beta + position: before x-endpoint-owners: - control-plane - infra x-fga-permissions: - - database_network_bans_read x-oauth-scope: projects:read + x-scalar-stability: experimental /v1/projects/{ref}/network-bans/retrieve/enriched: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-list-all-network-bans-enriched parameters: - name: ref @@ -2360,21 +2490,31 @@ paths: security: - bearer: [] summary: >- - [Beta] Gets project's network bans with additional information about - which databases they affect + Gets project's network bans with additional information about which + databases they affect tags: - Projects x-badges: - name: 'OAuth scope: projects:read' position: after + - name: Beta + position: before x-endpoint-owners: - control-plane - infra x-fga-permissions: - - database_network_bans_read x-oauth-scope: projects:read + x-scalar-stability: experimental /v1/projects/{ref}/network-bans: delete: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-delete-network-bans parameters: - name: ref @@ -2406,20 +2546,30 @@ paths: description: Failed to remove network bans. security: - bearer: [] - summary: '[Beta] Remove network bans.' + summary: Remove network bans. tags: - Projects x-badges: - name: 'OAuth scope: projects:write' position: after + - name: Beta + position: before x-endpoint-owners: - control-plane - infra x-fga-permissions: - - database_network_bans_write x-oauth-scope: projects:write + x-scalar-stability: experimental /v1/projects/{ref}/network-restrictions: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-get-network-restrictions parameters: - name: ref @@ -2449,19 +2599,29 @@ paths: description: Failed to retrieve project's network restrictions security: - bearer: [] - summary: '[Beta] Gets project''s network restrictions' + summary: Gets project's network restrictions tags: - Projects x-badges: - name: 'OAuth scope: projects:read' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - database_network_restrictions_read x-oauth-scope: projects:read + x-scalar-stability: experimental patch: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Alpha** stage. operationId: v1-patch-network-restrictions parameters: - name: ref @@ -2497,22 +2657,30 @@ paths: description: Failed to update project network restrictions security: - bearer: [] - summary: >- - [Alpha] Updates project's network restrictions by adding or removing - CIDRs + summary: Updates project's network restrictions by adding or removing CIDRs tags: - Projects x-badges: - name: 'OAuth scope: projects:write' position: after + - name: Alpha + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - database_network_restrictions_write x-oauth-scope: projects:write + x-scalar-stability: experimental /v1/projects/{ref}/network-restrictions/apply: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-update-network-restrictions parameters: - name: ref @@ -2548,20 +2716,30 @@ paths: description: Failed to update project network restrictions security: - bearer: [] - summary: '[Beta] Updates project''s network restrictions' + summary: Updates project's network restrictions tags: - Projects x-badges: - name: 'OAuth scope: projects:write' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - database_network_restrictions_write x-oauth-scope: projects:write + x-scalar-stability: experimental /v1/projects/{ref}/pgsodium: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-get-pgsodium-config parameters: - name: ref @@ -2591,18 +2769,28 @@ paths: description: Failed to retrieve project's pgsodium config security: - bearer: [] - summary: '[Beta] Gets project''s pgsodium config' + summary: Gets project's pgsodium config tags: - Secrets x-badges: - name: 'OAuth scope: secrets:read' position: after + - name: Beta + position: before x-endpoint-owners: - infra x-fga-permissions: - - project_admin_write x-oauth-scope: secrets:read + x-scalar-stability: experimental put: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-update-pgsodium-config parameters: - name: ref @@ -2639,18 +2827,21 @@ paths: security: - bearer: [] summary: >- - [Beta] Updates project's pgsodium config. Updating the root_key can - cause all data encrypted with the older key to become inaccessible. + Updates project's pgsodium config. Updating the root_key can cause all + data encrypted with the older key to become inaccessible. tags: - Secrets x-badges: - name: 'OAuth scope: secrets:write' position: after + - name: Beta + position: before x-endpoint-owners: - infra x-fga-permissions: - - project_admin_write x-oauth-scope: secrets:write + x-scalar-stability: experimental /v1/projects/{ref}/postgrest: get: operationId: v1-get-postgrest-service-config @@ -3010,6 +3201,13 @@ paths: x-oauth-scope: secrets:write /v1/projects/{ref}/ssl-enforcement: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-get-ssl-enforcement-config parameters: - name: ref @@ -3039,19 +3237,29 @@ paths: description: Failed to retrieve project's SSL enforcement config security: - bearer: [] - summary: '[Beta] Get project''s SSL enforcement configuration.' + summary: Get project's SSL enforcement configuration. tags: - Database x-badges: - name: 'OAuth scope: database:read' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - database_ssl_config_read x-oauth-scope: database:read + x-scalar-stability: experimental put: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-update-ssl-enforcement-config parameters: - name: ref @@ -3087,18 +3295,21 @@ paths: description: Failed to update project's SSL enforcement configuration. security: - bearer: [] - summary: '[Beta] Update project''s SSL enforcement configuration.' + summary: Update project's SSL enforcement configuration. tags: - Database x-badges: - name: 'OAuth scope: database:write' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - database_ssl_config_write x-oauth-scope: database:write + x-scalar-stability: experimental /v1/projects/{ref}/types/typescript: get: description: Returns the TypeScript types of your schema for use with supabase-js. @@ -3151,6 +3362,13 @@ paths: x-oauth-scope: database:read /v1/projects/{ref}/vanity-subdomain: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-get-vanity-subdomain-config parameters: - name: ref @@ -3188,7 +3406,7 @@ paths: description: Failed to get project vanity subdomain configuration security: - bearer: [] - summary: '[Beta] Gets current vanity subdomain config' + summary: Gets current vanity subdomain config tags: - Domains x-allowed-plans: @@ -3198,6 +3416,8 @@ paths: x-badges: - name: 'OAuth scope: domains:read' position: after + - name: Beta + position: before - name: Only available on Pro, Team, Enterprise position: before x-endpoint-owners: @@ -3206,7 +3426,15 @@ paths: x-fga-permissions: - - vanity_subdomain_read x-oauth-scope: domains:read + x-scalar-stability: experimental delete: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-deactivate-vanity-subdomain-config parameters: - name: ref @@ -3232,20 +3460,30 @@ paths: description: Failed to delete project vanity subdomain configuration security: - bearer: [] - summary: '[Beta] Deletes a project''s vanity subdomain configuration' + summary: Deletes a project's vanity subdomain configuration tags: - Domains x-badges: - name: 'OAuth scope: domains:write' position: after + - name: Beta + position: before x-endpoint-owners: - infra - control-plane x-fga-permissions: - - vanity_subdomain_write x-oauth-scope: domains:write + x-scalar-stability: experimental /v1/projects/{ref}/vanity-subdomain/check-availability: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-check-vanity-subdomain-availability parameters: - name: ref @@ -3289,7 +3527,7 @@ paths: description: Failed to check project vanity subdomain configuration security: - bearer: [] - summary: '[Beta] Checks vanity subdomain availability' + summary: Checks vanity subdomain availability tags: - Domains x-allowed-plans: @@ -3299,6 +3537,8 @@ paths: x-badges: - name: 'OAuth scope: domains:write' position: after + - name: Beta + position: before - name: Only available on Pro, Team, Enterprise position: before x-endpoint-owners: @@ -3307,8 +3547,16 @@ paths: x-fga-permissions: - - vanity_subdomain_write x-oauth-scope: domains:write + x-scalar-stability: experimental /v1/projects/{ref}/vanity-subdomain/activate: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-activate-vanity-subdomain-config parameters: - name: ref @@ -3352,7 +3600,7 @@ paths: description: Failed to activate project vanity subdomain configuration security: - bearer: [] - summary: '[Beta] Activates a vanity subdomain for a project.' + summary: Activates a vanity subdomain for a project. tags: - Domains x-allowed-plans: @@ -3362,6 +3610,8 @@ paths: x-badges: - name: 'OAuth scope: domains:write' position: after + - name: Beta + position: before - name: Only available on Pro, Team, Enterprise position: before x-endpoint-owners: @@ -3370,8 +3620,16 @@ paths: x-fga-permissions: - - vanity_subdomain_write x-oauth-scope: domains:write + x-scalar-stability: experimental /v1/projects/{ref}/upgrade: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-upgrade-postgres-version parameters: - name: ref @@ -3407,12 +3665,14 @@ paths: description: Failed to initiate project upgrade security: - bearer: [] - summary: '[Beta] Upgrades the project''s Postgres version' + summary: Upgrades the project's Postgres version tags: - Projects x-badges: - name: 'OAuth scope: projects:write' position: after + - name: Beta + position: before x-endpoint-owners: - control-plane - infra @@ -3420,8 +3680,16 @@ paths: - - project_admin_write - database_write x-oauth-scope: projects:write + x-scalar-stability: experimental /v1/projects/{ref}/upgrade/eligibility: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-get-postgres-upgrade-eligibility parameters: - name: ref @@ -3451,12 +3719,14 @@ paths: description: Failed to determine project upgrade eligibility security: - bearer: [] - summary: '[Beta] Returns the project''s eligibility for upgrades' + summary: Returns the project's eligibility for upgrades tags: - Projects x-badges: - name: 'OAuth scope: projects:read' position: after + - name: Beta + position: before x-endpoint-owners: - control-plane - infra @@ -3464,8 +3734,16 @@ paths: - - project_admin_read - database_read x-oauth-scope: projects:read + x-scalar-stability: experimental /v1/projects/{ref}/upgrade/status: get: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-get-postgres-upgrade-status parameters: - name: ref @@ -3501,12 +3779,14 @@ paths: description: Failed to retrieve project upgrade status security: - bearer: [] - summary: '[Beta] Gets the latest status of the project''s upgrade' + summary: Gets the latest status of the project's upgrade tags: - Projects x-badges: - name: 'OAuth scope: projects:read' position: after + - name: Beta + position: before x-endpoint-owners: - control-plane - infra @@ -3514,6 +3794,7 @@ paths: - - project_admin_read - database_read x-oauth-scope: projects:read + x-scalar-stability: experimental /v1/projects/{ref}/readonly: get: operationId: v1-get-readonly-mode-status @@ -3600,6 +3881,13 @@ paths: x-oauth-scope: database:write /v1/projects/{ref}/read-replicas/setup: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-setup-a-read-replica parameters: - name: ref @@ -3639,7 +3927,7 @@ paths: description: Failed to set up read replica security: - bearer: [] - summary: '[Beta] Set up a read replica' + summary: Set up a read replica tags: - Database x-allowed-plans: @@ -3647,6 +3935,8 @@ paths: - Team - Enterprise x-badges: + - name: Beta + position: before - name: Only available on Pro, Team, Enterprise position: before x-endpoint-owners: @@ -3654,8 +3944,16 @@ paths: - infra x-fga-permissions: - - infra_read_replicas_write + x-scalar-stability: experimental /v1/projects/{ref}/read-replicas/remove: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-remove-a-read-replica parameters: - name: ref @@ -3687,14 +3985,18 @@ paths: description: Failed to remove read replica security: - bearer: [] - summary: '[Beta] Remove a read replica' + summary: Remove a read replica tags: - Database + x-badges: + - name: Beta + position: before x-endpoint-owners: - control-plane - infra x-fga-permissions: - - infra_read_replicas_write + x-scalar-stability: experimental /v1/projects/{ref}/health: get: operationId: v1-get-services-health @@ -4837,7 +5139,6 @@ paths: x-internal: true /v1/projects/{ref}/advisors/performance: get: - deprecated: true description: >- This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported @@ -4880,9 +5181,9 @@ paths: x-fga-permissions: - - advisors_read x-oauth-scope: database:read + x-scalar-stability: experimental /v1/projects/{ref}/advisors/security: get: - deprecated: true description: >- This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported @@ -4933,6 +5234,7 @@ paths: x-fga-permissions: - - advisors_read x-oauth-scope: database:read + x-scalar-stability: experimental /v1/projects/{ref}/analytics/endpoints/logs.all: get: deprecated: true @@ -5313,6 +5615,13 @@ paths: x-oauth-scope: analytics:read /v1/projects/{ref}/cli/login-role: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-create-login-role parameters: - name: ref @@ -5348,18 +5657,28 @@ paths: description: Failed to create login role security: - bearer: [] - summary: '[Beta] Create a login role for CLI with temporary password' + summary: Create a login role for CLI with temporary password tags: - Database x-badges: - name: 'OAuth scope: database:write' position: after + - name: Beta + position: before x-endpoint-owners: - dev-workflows x-fga-permissions: - - database_write x-oauth-scope: database:write + x-scalar-stability: experimental delete: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-delete-login-roles parameters: - name: ref @@ -5389,17 +5708,20 @@ paths: description: Failed to delete login roles security: - bearer: [] - summary: '[Beta] Delete existing login roles used by CLI' + summary: Delete existing login roles used by CLI tags: - Database x-badges: - name: 'OAuth scope: database:write' position: after + - name: Beta + position: before x-endpoint-owners: - dev-workflows x-fga-permissions: - - database_write x-oauth-scope: database:write + x-scalar-stability: experimental /v1/projects/{ref}/database/migrations: get: operationId: v1-list-migration-history @@ -5686,6 +6008,13 @@ paths: x-oauth-scope: database:write /v1/projects/{ref}/database/query: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-run-a-query parameters: - name: ref @@ -5717,21 +6046,27 @@ paths: description: Failed to run sql query security: - bearer: [] - summary: '[Beta] Run sql query' + summary: Run sql query tags: - Database x-badges: - name: 'OAuth scope: database:write' position: after + - name: Beta + position: before x-endpoint-owners: - control-plane x-fga-permissions: - - database_read - - database_write x-oauth-scope: database:write + x-scalar-stability: experimental /v1/projects/{ref}/database/query/read-only: post: - description: All entity references must be schema qualified. + description: |- + All entity references must be schema qualified. + + This endpoint is currently in its **Beta** stage. operationId: v1-read-only-query parameters: - name: ref @@ -5763,19 +6098,29 @@ paths: description: Failed to run read-only sql query security: - bearer: [] - summary: '[Beta] Run a sql query as supabase_read_only_user' + summary: Run a sql query as supabase_read_only_user tags: - Database x-badges: - name: 'OAuth scope: database:read' position: after + - name: Beta + position: before x-endpoint-owners: - control-plane x-fga-permissions: - - database_read x-oauth-scope: database:read + x-scalar-stability: experimental /v1/projects/{ref}/database/webhooks/enable: post: + description: >- + This is an **experimental** endpoint. It is subject to change or removal + in future versions. Use it with caution, as it may not remain supported + or stable. + + + This endpoint is currently in its **Beta** stage. operationId: v1-enable-database-webhook parameters: - name: ref @@ -5801,21 +6146,23 @@ paths: description: Failed to enable Database Webhooks on the project security: - bearer: [] - summary: '[Beta] Enables Database Webhooks on the project' + summary: Enables Database Webhooks on the project tags: - Database x-badges: - name: 'OAuth scope: database:write' position: after + - name: Beta + position: before x-endpoint-owners: - control-plane - infra x-fga-permissions: - - database_webhooks_config_write x-oauth-scope: database:write + x-scalar-stability: experimental /v1/projects/{ref}/database/context: get: - deprecated: true description: >- This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported @@ -5858,6 +6205,7 @@ paths: x-fga-permissions: - - database_read x-oauth-scope: projects:read + x-scalar-stability: experimental /v1/projects/{ref}/database/password: patch: operationId: v1-update-database-password