{"note":"OpenAPI conversion -- returning structured metadata","name":"planetscale","description":"PlanetScale API","version":"v1","base_url":"https://api.planetscale.com/v1","endpoints":276,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api PlanetScale API\n@base https://api.planetscale.com/v1\n@version v1\n@auth OAuth2\n@common_fields {organization: any # Organization name slug from `list_organizations`. Example: `acme`.}\n@endpoints 276\n@hint download_for_search\n@toc organizations(273), postgres-versions(1), regions(1), user(1)\n\n@group organizations\n@endpoint GET /organizations\n@desc List organizations\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Gets the organizations for the current user\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}\n@desc Get an organization\n@returns(200) Returns an organization\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}\n@desc Update an organization\n@optional {body: map}\n@returns(200) Returns the updated organization\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/audit-log\n@desc List audit logs\n@optional {starting_after: any # If provided, returns results after the specified cursor, ending_before: any # If provided, returns results before the specified cursor, limit: any # If provided, specifies the number of returned results (max 100)}\n@returns(200) Returns the audit log events\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/billing/payment-method\n@desc Get the current billing payment method\n@returns(200) Returns the organization's payment method\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/billing/payment-method\n@desc Delete the current billing payment method\n@returns(204) The billing payment method was deleted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/billing/payment-method-setups\n@desc Create a billing payment method setup\n@returns(201) Returns the billing payment method setup\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/billing/payment-method-setups/{id}\n@desc Get a billing payment method setup\n@required {id: any # Billing payment method setup ID from `update_payment_method`. Example: `pmsetup_1234`.}\n@returns(200) Returns the billing payment method setup\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/cluster-size-skus\n@desc List available cluster sizes\n@optional {engine: any # The database engine to filter by. Defaults to 'mysql'., rates: any # Whether to include pricing rates in the response. Defaults to false., region: any # The region slug to get rates for. If not specified, uses the organization's default region., database: any # The database name to resolve rates for. When specified, database-level custom rates take precedence over organization rates., external: any # When true, list cluster sizes for external keyspaces. Defaults to false.}\n@returns(200) Returns available cluster sizes with optional pricing rates\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases\n@desc List databases\n@optional {q: any # Search term to filter databases by name, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Retrieves the databases for an organization\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases\n@desc Create a database\n@optional {body: map}\n@returns(201) Returns the created database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}\n@desc Get a database\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@returns(200) Returns a database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}\n@desc Update database settings\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {body: map}\n@returns(200) Returns the updated database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}\n@desc Delete a database\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@returns(204) Deletes a database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/backup-policies\n@desc List backup policies\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns backup policies for the database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/backup-policies\n@desc Create a backup policy\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {body: map}\n@returns(201) Returns the created backup policy\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/backup-policies/{id}\n@desc Get a backup policy\n@required {id: any # The ID of the backup policy, database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@returns(200) Returns a backup policy\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/backup-policies/{id}\n@desc Update a backup policy\n@required {id: any # The ID of the backup policy, database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {body: map}\n@returns(200) Returns the updated backup policy\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/backup-policies/{id}\n@desc Delete a backup policy\n@required {id: any # The ID of the backup policy, database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@returns(204) Returns no content\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches\n@desc List branches\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {q: any # Search branches by name, production: any # Filter branches by production status, safe_migrations: any # Filter branches by safe migrations (DDL protection), order: any # Order branches by created_at time, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns database branches\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches\n@desc Create a branch\n@required {database: any # The name of the database the branch belongs to}\n@optional {body: map}\n@returns(201) Returns the created branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}\n@desc Get a branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns information about a branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}\n@desc Update a branch\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {body: map}\n@returns(200) Returns the updated branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}\n@desc Delete a branch\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {delete_descendants: any # If true, recursively delete all descendant branches along with this branch}\n@returns(204) Delete a branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/admin\n@desc Get the admin for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns the admin\n@errors {401: Unauthorized, 403: Forbidden, 404: Admin not found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/admin\n@desc Update the admin for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(200) Returns the admin\n@errors {401: Unauthorized, 403: Forbidden, 404: Admin not found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/admin-size-skus\n@desc List admin size SKUs for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns admin size SKUs\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/admin/changes\n@desc List change requests for a Neki admin\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, period: any # Filter change requests by named period, completed_at: any # Filter change requests completed between two ISO 8601 timestamps}\n@errors {308: Redirects to the Neki change requests endpoint, 401: Unauthorized, 403: Forbidden, 404: Admin not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/admin/changes/{id}\n@desc Get a change request for a Neki admin\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the change request}\n@errors {308: Redirects to the Neki change request endpoint, 401: Unauthorized, 403: Forbidden, 404: Admin or change request not found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/admin/changes/{id}\n@desc Cancel a change request for a Neki admin\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the change request}\n@errors {308: Redirects to the Neki change request endpoint, 401: Unauthorized, 403: Forbidden, 404: Admin or change request not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/admin/parameters\n@desc List parameters for a Neki admin\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns parameters for the admin\n@errors {401: Unauthorized, 403: Forbidden, 404: Admin not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/backups\n@desc List backups\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {all: any # Whether to include all backups, including deleted ones, state: any # Filter backups by state, policy: any # Filter backups by backup policy ID, from: any # Filter backups started after this date (e.g. 2023-01-01T00:00:00Z), to: any # Filter backups started before this date (e.g. 2023-01-31T23:59:59Z), running_at: any # Filter backups that are running during a specific time (e.g. 2023-01-01T00:00:00Z..2023-01-01T23:59:59Z), production: any # Filter backups by production branch, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns database branch backups\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/backups\n@desc Create a backup\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {body: map}\n@returns(201) Returns the created database branch backup\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/backups/{id}\n@desc Get a backup\n@required {id: any # The ID for the backup, database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@returns(200) Returns a database branch backup\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/backups/{id}\n@desc Update a backup\n@required {id: any # The ID of the backup, database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {body: map}\n@returns(200) Returns the backup\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/backups/{id}\n@desc Delete a backup\n@required {id: any # The ID of the backup, database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@returns(204) Delete a backup\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/bouncer-resizes\n@desc Get bouncer resize requests\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns bouncer resize requests\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/bouncers\n@desc List bouncers\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns bouncers\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/bouncers\n@desc Create a bouncer\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(200) Returns the new bouncer\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}\n@desc Get a bouncer\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., bouncer: any # The name of the bouncer}\n@returns(200) Returns a bouncer\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}\n@desc Delete a bouncer\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., bouncer: any # The name of the bouncer}\n@returns(204) Deletes the bouncer\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes\n@desc Get bouncer resize requests\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., bouncer: any # The name of the bouncer}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns bouncer resize requests\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes\n@desc Upsert a bouncer resize request\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., bouncer: any # The name of the bouncer}\n@optional {body: map}\n@returns(200) Returns bouncer resize request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes\n@desc Cancel a resize request\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., bouncer: any # The name of the bouncer}\n@returns(204) Cancels a resize request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/changes\n@desc Get branch change requests\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns branch change requests\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/changes\n@desc Upsert a change request for cluster size, replicas, storage, or parameters\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(200) Returns the branch change request\n@returns(204) No changes to apply\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/changes/{id}\n@desc Get a branch change request\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the change request}\n@returns(200) Returns a branch change request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/cluster\n@desc Change a branch cluster configuration\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch to configure}\n@optional {body: map}\n@returns(204) Returns an empty response body\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles\n@desc List shard configuration profiles for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns shard configuration profiles for the branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles\n@desc Create a shard configuration profile for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(201) Returns the created shard configuration profile\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/maintenance\n@desc Run maintenance for selected Neki shard configuration profiles\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(204) Maintenance started\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 422: Invalid configuration profile names, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}\n@desc Get a shard configuration profile for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@returns(200) Returns the shard configuration profile\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}\n@desc Update a shard configuration profile for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@optional {body: map}\n@returns(200) Returns the updated shard configuration profile\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}\n@desc Delete a shard configuration profile for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@returns(204) Shard configuration profile deleted\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/changes\n@desc List change requests for a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, period: any # Filter change requests by named period, completed_at: any # Filter change requests completed between two ISO 8601 timestamps}\n@errors {308: Redirects to the Neki change requests endpoint, 401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/changes/{id}\n@desc Get a change request for a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`., id: any # The ID of the change request}\n@errors {308: Redirects to the Neki change request endpoint, 401: Unauthorized, 403: Forbidden, 404: Shard configuration profile or change request not found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/changes/{id}\n@desc Cancel a change request for a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`., id: any # The ID of the change request}\n@errors {308: Redirects to the Neki change request endpoint, 401: Unauthorized, 403: Forbidden, 404: Shard configuration profile or change request not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/extensions\n@desc List extensions for a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@returns(200) Returns extensions for the shard configuration profile\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/extensions/{extension}\n@desc Enable or disable an extension for a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`., extension: any # The name of the extension}\n@optional {body: map}\n@returns(200) Returns the updated extension\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile or extension not found, 422: Extension cannot be enabled or disabled, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/maintenance\n@desc Run maintenance for a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@returns(204) Maintenance started\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/parameters\n@desc List parameters for a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@returns(200) Returns parameters for the shard configuration profile\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards\n@desc List shards for a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, q: any # Search shards by name or display name}\n@returns(200) Returns shards for the shard configuration profile\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards\n@desc Add a shard to a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@optional {body: map}\n@returns(201) Returns the created shard\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 422: Shard could not be created, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards\n@desc Assign shards to a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@optional {body: map}\n@returns(200) Returns an assignment result for each requested shard\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile or shard not found, 422: Invalid shard IDs, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards\n@desc Remove shards from a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`., shard_ids: any # The IDs of the shards to remove}\n@returns(204) Shards removed\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile or shard not found, 422: Shards could not be removed, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards/bulk\n@desc Add shards to a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`.}\n@optional {body: map}\n@returns(201) Returns the created shard IDs\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 422: Shards could not be created, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards/{id}\n@desc Get a shard in a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`., id: any # The ID of the shard}\n@returns(200) Returns the shard\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile or shard not found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards/{id}\n@desc Update a shard in a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`., id: any # The ID of the shard}\n@optional {body: map}\n@returns(200) Returns the updated shard\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile or shard not found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile}/shards/{id}\n@desc Remove a shard from a Neki shard configuration profile\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., configuration_profile: any # Name from `list_shard_configuration_profiles`., id: any # The ID of the shard}\n@returns(204) Shard removed\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile or shard not found, 422: Shard could not be removed, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/data-topology\n@desc Get the data topology for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns the data topology for the branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /organizations/{organization}/databases/{database}/branches/{branch}/data-topology\n@desc Set the data topology for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(200) Returns the updated data topology for the branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/default-configuration-profile\n@desc Get the default shard configuration profile for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@errors {302: Redirects to the default shard configuration profile, 401: Unauthorized, 403: Forbidden, 404: Default shard configuration profile not found, 500: Internal Server Error}\n\n@endpoint PUT /organizations/{organization}/databases/{database}/branches/{branch}/default-configuration-profile\n@desc Set the default shard configuration profile for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(200) Returns the new default shard configuration profile\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard configuration profile not found, 422: Default shard configuration profile could not be updated, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/demote\n@desc Demote a branch\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@returns(200) Returns a development branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/extensions\n@desc List cluster extensions\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns cluster extensions\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights\n@desc List branch queries\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {q: any # Search query statistics by SQL pattern, from: any # Start time for filtering query statistics (ISO 8601 timestamp), to: any # End time for filtering query statistics (ISO 8601 timestamp), period: any # Time period for filtering query statistics, sort: any # Field to sort by, dir: any # Sort direction, tablet_type: any # Filter by tablet type, type: any # Filter by statement type, fields: any # Specific fields to include in the response, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns query statistics summaries\n@errors {400: Invalid time range, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/anomalies\n@desc List branch anomalies\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {from: any # Start time for filtering anomalies (ISO 8601 timestamp), to: any # End time for filtering anomalies (ISO 8601 timestamp), period: any # Time period for filtering anomalies, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns anomalies detected on the branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/anomalies/{id}\n@desc Retrieve a branch anomaly\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The anomaly ID}\n@returns(200) Returns the anomaly and its correlated queries\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/errors\n@desc List branch query errors\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {q: any # Search query errors by error message, from: any # Start time for filtering query errors (ISO 8601 timestamp), to: any # End time for filtering query errors (ISO 8601 timestamp), period: any # Time period for filtering query errors, sort: any # Field to sort by, dir: any # Sort direction, tablet_type: any # Filter by tablet type, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns query error summaries\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/errors/{fingerprint}\n@desc List queries for an error fingerprint\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., fingerprint: any # The error fingerprint}\n@optional {from: any # Start time for filtering queries (ISO 8601 timestamp), to: any # End time for filtering queries (ISO 8601 timestamp), period: any # Time period for filtering queries, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns queries that failed with the given error fingerprint\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/queries/{id}\n@desc Retrieve a branch query\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The query ID}\n@returns(200) Returns a specific branch query\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/tags\n@desc List query tags\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {q: any # Search tags by name, from: any # Start time for filtering tags (ISO 8601 timestamp), to: any # End time for filtering tags (ISO 8601 timestamp), period: any # Time period for filtering tags, fingerprint: any # Filter to tags on queries with this fingerprint, keyspace: any # Filter by keyspace, tablet_type: any # Filter by tablet type, values_limit: any # Maximum number of values returned per tag (1-100), literal_values_only: any # Only return literal tag values, excluding overflow and collapsed values, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns tags found on branch queries\n@errors {400: Invalid time range, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/tags/summaries\n@desc List query statistics grouped by tag\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {tags: any # Tag ids returned by the tags list endpoint, q: any # Search query statistics by SQL pattern, from: any # Start time for filtering query statistics (ISO 8601 timestamp), to: any # End time for filtering query statistics (ISO 8601 timestamp), period: any # Time period for filtering query statistics, sort: any # Field to sort by, dir: any # Sort direction, tablet_type: any # Filter by tablet type, type: any # Filter by statement type, fields: any # Specific fields to include in the response, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns query statistics summaries grouped by tag\n@errors {400: Invalid time range, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/tags/{tag}\n@desc Retrieve a query tag\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., tag: any # The tag name}\n@optional {from: any # Start time for filtering tag values (ISO 8601 timestamp), to: any # End time for filtering tag values (ISO 8601 timestamp), period: any # Time period for filtering tag values, fingerprint: any # Filter to tag values on queries with this fingerprint, keyspace: any # Filter by keyspace, tablet_type: any # Filter by tablet type, values_limit: any # Maximum number of values returned (1-100), literal_values_only: any # Only return literal tag values, excluding overflow and collapsed values}\n@returns(200) Returns the tag and its values\n@errors {400: Invalid time range, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/{fingerprint}\n@desc Retrieve query statistics\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., fingerprint: any # The query fingerprint, keyspace: any # The keyspace to filter by}\n@optional {from: any # Start time for filtering query statistics (ISO 8601 timestamp), to: any # End time for filtering query statistics (ISO 8601 timestamp), period: any # Time period for filtering query statistics, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns detailed query statistics\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/{fingerprint}/summary\n@desc Retrieve a summary of query statistics\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., fingerprint: any # The query fingerprint, keyspace: any # The keyspace to filter by}\n@optional {from: any # Start time for filtering query statistics (ISO 8601 timestamp), to: any # End time for filtering query statistics (ISO 8601 timestamp), period: any # Time period for filtering query statistics}\n@returns(200) Returns aggregated query statistics summary\n@errors {400: Invalid time range, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/insights/{fingerprint}/traffic/budgets\n@desc List traffic budgets affecting a query fingerprint\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., fingerprint: any # The query fingerprint}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, keyspace: any # Optional keyspace filter}\n@returns(200) Returns the traffic budgets affecting the query fingerprint\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces\n@desc Get keyspaces\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns keyspaces\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces\n@desc Create a keyspace\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {body: map}\n@returns(200) Returns a created keyspace\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}\n@desc Get a keyspace\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace}\n@returns(200) Returns information about a keyspace\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}\n@desc Configure keyspace settings\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace}\n@optional {body: map}\n@returns(200) Returns the keyspace\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}\n@desc Delete a keyspace\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace}\n@returns(204) Delete a keyspace\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/resizes\n@desc Get keyspace resize requests\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, completed_at: any # Filter resize requests completed between two dates (e.g. 2023-01-01T:00:00:00Z..2023-01-31T:23:59:59Z)}\n@returns(200) Returns keyspaces resize requests\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/resizes\n@desc Upsert a resize request\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace}\n@optional {body: map}\n@returns(200) Returns keyspace resize request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/resizes\n@desc Cancel a resize request\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace}\n@returns(204) Cancels a resize request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/resizes/{id}\n@desc Get a keyspace resize request\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace, id: any # The ID of the resize request}\n@returns(200) Returns a keyspace resize request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/rollout-status\n@desc Get keyspace rollout status\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace}\n@returns(200) Returns information about a keyspace's rollout\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema\n@desc Get the VSchema for the keyspace\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace}\n@returns(200) Returns the VSchema for the keyspace\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema\n@desc Update the VSchema for the keyspace\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, keyspace: any # The name of the keyspace}\n@optional {body: map}\n@returns(200) Returns the VSchema for the keyspace\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/logs/signatures\n@desc Create a log signature\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns a log signature\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/maintenance\n@desc Run maintenance for a Postgres branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(204) Maintenance started\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/metrics\n@desc Get time-series metrics\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {metrics: any # Metric names to retrieve. Pass as `metrics[]=name` (repeat for multiple), `metrics=name`, or a comma-separated list (`metrics=name,other`). Time range is `period` (for example `15m`) or ISO 8601 `from`/`to`., period: any # Named time period to retrieve. Defaults to 12h., from: any # Start of a custom time range as an ISO 8601 timestamp, to: any # End of a custom time range as an ISO 8601 timestamp, steps: any # Number of data points to return, tablet_type: any # Filter by tablet type, keyspace: any # Filter by keyspace, shard: any # Filter by shard, shard_config_profile: any # Filter by shard configuration profile name, router: any # Filter by router, role: any # Filter by Postgres role, container: any # Filter by container, pod: any # Filter by pod, pods: any # Filter by pods, query_ids: any # Filter by query pattern IDs, fingerprint: any # Filter by query fingerprint, budget_id: any # Filter by traffic budget ID, rule_id: any # Filter by traffic rule ID, q: any # Filter by search terms}\n@returns(200) Returns time-series metrics\n@errors {400: Malformed metrics parameter, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error, 503: Metrics service unavailable}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/metrics/instant\n@desc Get current metric values\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {metrics: any # Metric names to retrieve. Pass as `metrics[]=name` (repeat for multiple), `metrics=name`, or a comma-separated list (`metrics=name,other`)., role: any # Filter by Postgres role, shard: any # Filter by shard, shard_config_profile: any # Filter by shard configuration profile name, container: any # Filter by container, pod: any # Filter by pod}\n@returns(200) Returns current metrics\n@errors {400: Malformed metrics parameter, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error, 503: Metrics service unavailable}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/metrics/keyspace-tables\n@desc Get table storage metrics by keyspace\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns storage metrics keyed by keyspace and table name\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/metrics/query\n@desc Get time-series metrics for SQL queries\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {metrics: any # Metric names to retrieve. Pass as `metrics[]=name` (repeat for multiple), `metrics=name`, or a comma-separated list (`metrics=name,other`). Time range is `period` (for example `15m`) or ISO 8601 `from`/`to`., query_ids: any # Query pattern IDs to retrieve metrics for, fingerprint: any # Filter by query fingerprint, keyspace: any # Keyspace for the query fingerprint, period: any # Named time period to retrieve. Defaults to 12h., from: any # Start of a custom time range as an ISO 8601 timestamp, to: any # End of a custom time range as an ISO 8601 timestamp, steps: any # Number of data points to return, tablet_type: any # Filter by tablet type, budget_id: any # Filter by traffic budget ID, rule_id: any # Filter by traffic rule ID, q: any # Filter by search terms}\n@returns(200) Returns time-series metrics for SQL queries\n@errors {400: Malformed metrics parameter, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/metrics/tables\n@desc Get table storage metrics\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns storage metrics keyed by table name\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/metrics/tablets\n@desc Get time-series tablet metrics\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {metrics: any # Metric names to retrieve. Pass as `metrics[]=name` (repeat for multiple), `metrics=name`, or a comma-separated list (`metrics=name,other`). Time range is `period` (for example `15m`) or ISO 8601 `from`/`to`., period: any # Named time period to retrieve. Defaults to 12h., from: any # Start of a custom time range as an ISO 8601 timestamp, to: any # End of a custom time range as an ISO 8601 timestamp, steps: any # Number of data points to return, keyspace: any # Filter by keyspace, shard: any # Filter by shard, pod: any # Filter by pod, workflow: any # Filter by workflow ID}\n@returns(200) Returns time-series tablet metrics\n@errors {400: Malformed metrics parameter, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error, 503: Metrics service unavailable}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/metrics/tablets-instant\n@desc Get current tablet metrics\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {metrics: any # Metric names to retrieve. Pass as `metrics[]=name` (repeat for multiple), `metrics=name`, or a comma-separated list (`metrics=name,other`)., keyspace: any # Filter by keyspace, shard: any # Filter by shard}\n@returns(200) Returns current tablet metrics\n@errors {400: Malformed metrics parameter, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error, 503: Metrics service unavailable}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/metrics/tag\n@desc Get time-series metrics grouped by query tags\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {metrics: any # Metric names to retrieve. Pass as `metrics[]=name` (repeat for multiple), `metrics=name`, or a comma-separated list (`metrics=name,other`). Time range is `period` (for example `15m`) or ISO 8601 `from`/`to`., tag_sets: any # Tag sets to retrieve metrics for, period: any # Named time period to retrieve. Defaults to 12h., from: any # Start of a custom time range as an ISO 8601 timestamp, to: any # End of a custom time range as an ISO 8601 timestamp, steps: any # Number of data points to return, tablet_type: any # Filter by tablet type, budget_id: any # Filter by traffic budget ID, rule_id: any # Filter by traffic rule ID, q: any # Filter by search terms}\n@returns(200) Returns time-series metrics grouped by query tags\n@errors {400: Invalid tag filter or malformed metrics parameter, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/neki-changes\n@desc List change requests for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, state: any # Filter change requests by state, target_types: any # Filter change requests by target type. Must contain one or more of: NekiAdmin, NekiCluster, NekiConfigurationProfile, NekiRouter, or NekiSidecar, target_id: any # Filter change requests by target ID. Requires target_types, period: any # Filter change requests by named period, completed_at: any # Filter change requests completed between two ISO 8601 timestamps}\n@returns(200) Returns Neki change requests\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/neki-changes/{id}\n@desc Get a change request for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the change request}\n@returns(200) Returns a Neki change request\n@errors {401: Unauthorized, 403: Forbidden, 404: Change request not found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/neki-changes/{id}\n@desc Cancel a change request for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the change request}\n@returns(204) Change request canceled\n@errors {401: Unauthorized, 403: Forbidden, 404: Change request not found, 422: Change request cannot be canceled, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/parameters\n@desc List cluster parameters\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns cluster parameters\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/passwords\n@desc List passwords\n@required {database: any # The name of the database the password belongs to, branch: any # The name of the branch the password belongs to}\n@optional {read_only_region_id: any # A read-only region of the database branch. If present, the password results will be filtered to only those in the region, status: any # Filter passwords by status, q: any # Search passwords by name, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns passwords for the branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/passwords\n@desc Create a password\n@required {database: any # The name of the database the password belongs to, branch: any # The name of the branch the password belongs to}\n@optional {body: map}\n@returns(201) Returns the new credentials\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}\n@desc Get a password\n@required {database: any # The name of the database the password belongs to, branch: any # The name of the branch the password belongs to, id: any # The ID of the password}\n@returns(200) Returns a password\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}\n@desc Update a password\n@required {database: any # The name of the database the password belongs to, branch: any # The name of the branch the password belongs to, id: any # The ID of the password}\n@optional {body: map}\n@returns(200) Returns the updated password\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}\n@desc Delete a password\n@required {database: any # The name of the database the password belongs to, branch: any # The name of the branch the password belongs to, id: any # The ID of the password}\n@returns(204) Deletes the password\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}/renew\n@desc Renew a password\n@required {database: any # The name of the database the password belongs to, branch: any # The name of the branch the password belongs to, id: any # The ID of the password}\n@returns(200) Returns the renewed password\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/promote\n@desc Promote a branch\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@returns(200) Returns a production branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns\n@desc List generated query patterns reports\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {starting_after: any # If provided, returns results after the specified cursor, ending_before: any # If provided, returns results before the specified cursor, limit: any # If provided, specifies the number of returned results (max 100)}\n@returns(200) Returns the generated query patterns reports\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns\n@desc Create a new query patterns report\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@returns(201) The created query patterns download\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}\n@desc Show the status of a query patterns report\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, id: any # The ID of the query patterns report}\n@returns(200) The retrieved query patterns download\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}\n@desc Delete a query patterns report\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, id: any # The ID of the query patterns report}\n@returns(204) Delete a query patterns report\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}/download\n@desc Download a finished query patterns report\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, id: any # The ID of the query patterns report}\n@errors {302: Redirect to the query patterns download, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/read-only-replica-changes\n@desc Get read-only replica change requests\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, period: any # Filter change requests by named period, completed_at: any # Filter change requests completed between two ISO 8601 timestamps}\n@returns(200) Returns read-only replica change requests\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/read-only-replicas\n@desc List read-only replicas\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns read-only replicas\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/read-only-replicas\n@desc Create a read-only replica\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(200) Returns the new read-only replica\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/read-only-replicas/{read_only_replica}\n@desc Get a read-only replica\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., read_only_replica: any # The name of the read-only replica}\n@returns(200) Returns the read-only replica\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/read-only-replicas/{read_only_replica}\n@desc Update a read-only replica\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., read_only_replica: any # The name of the read-only replica}\n@optional {body: map}\n@returns(200) Returns the updated read-only replica\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/read-only-replicas/{read_only_replica}\n@desc Delete a read-only replica\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., read_only_replica: any # The name of the read-only replica}\n@returns(204) Deletes the read-only replica\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/resizes\n@desc Cancel a change request\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(204) Cancels a change request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/resizes\n@desc Get branch resize requests\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns branch resize requests\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /organizations/{organization}/databases/{database}/branches/{branch}/resizes\n@desc Upsert a resize request\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {body: map}\n@returns(200) Returns branch resize request\n@returns(204) No changes to apply\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/resizes/{resize}\n@desc Get a branch resize request\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch, resize: any # The ID of the branch resize request}\n@returns(200) Returns a branch resize request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/roles\n@desc List roles\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, status: any # Filter roles by status, q: any # Search roles by name or username}\n@returns(200) Returns roles\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/roles\n@desc Create role credentials\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(200) Returns the new credentials\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/roles/default\n@desc Get the default postgres role\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns the default postgres role\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/roles/reset-default\n@desc Reset default credentials\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns the new credentials\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}\n@desc Get a role\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the role}\n@optional {replica: any # Return connection details for a replica, read_only_replica: any # Return connection details for this read-only replica, bouncer: any # Return connection details for this bouncer, router: any # Return connection details for this Neki router group, shard: any # Return libpq options that pin this Neki shard}\n@returns(200) Returns a role\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}\n@desc Update role name\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the role}\n@optional {body: map}\n@returns(200) Returns the updated role\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}\n@desc Delete role credentials\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the role}\n@optional {successor: any # The optional role to reassign ownership to before dropping. Accepts the role's ID, or its username with or without the branch ID suffix.}\n@returns(204) Deletes the role credentials\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reassign\n@desc Reassign objects owned by one role to another role\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the role}\n@optional {body: map}\n@returns(204) Objects reassigned successfully\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/renew\n@desc Renew role expiration\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the role}\n@returns(200) Returns the renewed role\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reset\n@desc Reset a role's password\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the role}\n@returns(200) Returns the role with new password\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/router-size-skus\n@desc List router size SKUs for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns router size SKUs\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/routers\n@desc List routers for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns routers for the branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/routers\n@desc Create a router for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(201) Returns the created router\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}\n@desc Get a router for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., router: any # Name from `list_routers`.}\n@returns(200) Returns the router\n@errors {401: Unauthorized, 403: Forbidden, 404: Router not found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}\n@desc Update a router for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., router: any # Name from `list_routers`.}\n@optional {body: map}\n@returns(200) Returns the router\n@errors {401: Unauthorized, 403: Forbidden, 404: Router not found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}\n@desc Delete a router from a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., router: any # Name from `list_routers`.}\n@returns(204) Router deleted\n@errors {401: Unauthorized, 403: Forbidden, 404: Router not found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}/changes\n@desc List change requests for a Neki router\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., router: any # Name from `list_routers`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, period: any # Filter change requests by named period, completed_at: any # Filter change requests completed between two ISO 8601 timestamps}\n@errors {308: Redirects to the Neki change requests endpoint, 401: Unauthorized, 403: Forbidden, 404: Router not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}/changes/{id}\n@desc Get a change request for a Neki router\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., router: any # Name from `list_routers`., id: any # The ID of the change request}\n@errors {308: Redirects to the Neki change request endpoint, 401: Unauthorized, 403: Forbidden, 404: Router or change request not found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}/changes/{id}\n@desc Cancel a change request for a Neki router\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., router: any # Name from `list_routers`., id: any # The ID of the change request}\n@errors {308: Redirects to the Neki change request endpoint, 401: Unauthorized, 403: Forbidden, 404: Router or change request not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/routers/{router}/parameters\n@desc List parameters for a Neki router\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., router: any # Name from `list_routers`.}\n@returns(200) Returns parameters for the router\n@errors {401: Unauthorized, 403: Forbidden, 404: Router not found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations\n@desc Enable safe migrations for a branch\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@returns(200) Returns the branch with safe migrations enabled\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations\n@desc Update safe migrations for a branch\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {body: map}\n@returns(200) Returns the branch with safe migrations updated\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations\n@desc Disable safe migrations for a branch\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@returns(200) Returns the branch with safe migrations disabled\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/schema\n@desc Get a branch schema\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {keyspace: any # Return the schema for a single Vitess keyspace, namespace: any # Return the schema for a PostgreSQL catalog namespace in `.` format (e.g. public.schema1)}\n@returns(200) Gets the schema for the branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/schema/lint\n@desc Lint a branch schema\n@required {database: any # The name of the database the branch belongs to, branch: any # The name of the branch}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns a list of schema errors for a branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/shards\n@desc List shards for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, exclude_configuration_profile: any # Exclude shards in this shard configuration profile, q: any # Search shards by name, display name, or configuration profile}\n@returns(200) Returns shards for the branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/shards\n@desc Add shards to a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@errors {308: Redirects to the default shard configuration profile shards endpoint, 401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/shards/{id}\n@desc Get a shard for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the shard}\n@returns(200) Returns the shard\n@errors {401: Unauthorized, 403: Forbidden, 404: Shard not found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/shards/{id}\n@desc Update a shard for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the shard}\n@errors {308: Redirects to the shard configuration profile shard endpoint, 401: Unauthorized, 403: Forbidden, 404: Shard not found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/shards/{id}\n@desc Remove a shard from a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the shard}\n@errors {308: Redirects to the shard configuration profile shard endpoint, 401: Unauthorized, 403: Forbidden, 404: Shard not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/sidecars\n@desc List sidecars for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@returns(200) Returns sidecars for the branch, one per shard configuration profile\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/sidecars/{sidecar}\n@desc Get a sidecar for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., sidecar: any # ID from `list_sidecars`, or the configuration profile name.}\n@returns(200) Returns the sidecar\n@errors {401: Unauthorized, 403: Forbidden, 404: Sidecar not found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/sidecars/{sidecar}\n@desc Update a sidecar for a Neki branch\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., sidecar: any # ID from `list_sidecars`, or the configuration profile name.}\n@optional {body: map}\n@returns(200) Returns the sidecar\n@errors {401: Unauthorized, 403: Forbidden, 404: Sidecar not found, 422: Unprocessable Content, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/sidecars/{sidecar}/changes\n@desc List change requests for a Neki sidecar\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., sidecar: any # ID from `list_sidecars`, or the configuration profile name.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, period: any # Filter change requests by named period, completed_at: any # Filter change requests completed between two ISO 8601 timestamps}\n@errors {308: Redirects to the Neki change requests endpoint, 401: Unauthorized, 403: Forbidden, 404: Sidecar not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/sidecars/{sidecar}/changes/{id}\n@desc Get a change request for a Neki sidecar\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., sidecar: any # ID from `list_sidecars`, or the configuration profile name., id: any # The ID of the change request}\n@errors {308: Redirects to the Neki change request endpoint, 401: Unauthorized, 403: Forbidden, 404: Sidecar or change request not found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/sidecars/{sidecar}/changes/{id}\n@desc Cancel a change request for a Neki sidecar\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., sidecar: any # ID from `list_sidecars`, or the configuration profile name., id: any # The ID of the change request}\n@errors {308: Redirects to the Neki change request endpoint, 401: Unauthorized, 403: Forbidden, 404: Sidecar or change request not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/sidecars/{sidecar}/parameters\n@desc List parameters for a Neki sidecar\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., sidecar: any # ID from `list_sidecars`, or the configuration profile name.}\n@returns(200) Returns parameters for the sidecar\n@errors {401: Unauthorized, 403: Forbidden, 404: Sidecar not found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/switchovers\n@desc List switchovers\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns switchovers\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/switchovers\n@desc Create a switchover\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(201) Returns the new switchover\n@errors {400: bad request: candidate must be a string, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: unprocessable: the branch cannot accept a switchover right now, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/switchovers/{id}\n@desc Get a switchover\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the switchover}\n@returns(200) Returns a switchover\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets\n@desc List traffic budgets\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results, period: any # Time period filter, created_at: any # Filter by creation date range (format: 'start..end'), fingerprint: any # Filter budgets by query fingerprint}\n@returns(200) Returns the traffic budgets for the branch\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets\n@desc Create a traffic budget\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`.}\n@optional {body: map}\n@returns(201) Returns the created traffic budget\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{budget_id}/rules\n@desc Create a traffic rule\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., budget_id: any # The ID of the traffic budget}\n@optional {body: map}\n@returns(201) Returns the created traffic rule\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{budget_id}/rules/{id}\n@desc Delete a traffic rule\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., budget_id: any # The ID of the traffic budget, id: any # The ID of the traffic rule}\n@returns(204) Traffic rule successfully deleted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{id}\n@desc Get a traffic budget\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the traffic budget}\n@returns(200) Returns the traffic budget\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{id}\n@desc Update a traffic budget\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the traffic budget}\n@optional {body: map}\n@returns(200) Returns the updated traffic budget\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets/{id}\n@desc Delete a traffic budget\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., branch: any # Branch name from `list_branches`. Example: `main`., id: any # The ID of the traffic budget}\n@returns(204) Traffic budget successfully deleted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/cidrs\n@desc List IP restriction entries\n@required {database: any # The name of the database}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns IP restriction entries for the database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Invalid parameters or validation errors, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/cidrs\n@desc Create an IP restriction entry\n@required {database: any # The name of the database}\n@optional {body: map}\n@returns(201) Returns the created IP restriction entry\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Invalid parameters or validation errors, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/cidrs/{id}\n@desc Get an IP restriction entry\n@required {database: any # The name of the database, id: any # The ID of the IP restriction entry}\n@returns(200) Returns an IP restriction entry\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Invalid parameters or validation errors, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/cidrs/{id}\n@desc Update an IP restriction entry\n@required {database: any # The name of the database, id: any # The ID of the IP restriction entry}\n@optional {body: map}\n@returns(200) Returns the updated IP restriction entry\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Invalid parameters or validation errors, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/cidrs/{id}\n@desc Delete an IP restriction entry\n@required {database: any # The name of the database, id: any # The ID of the IP restriction entry}\n@returns(204) IP restriction entry deleted successfully. Note: This will also remove the restriction from all database branches.\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Invalid parameters or validation errors, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/deploy-queue\n@desc Get the deploy queue\n@required {database: any # The name of the deploy request's database}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns the deploy queue for a database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/deploy-requests\n@desc List deploy requests\n@required {database: any # The name of the deploy request's database}\n@optional {state: any # Filter by state of the deploy request (open, closed, deployed), branch: any # Filter by the name of the branch the deploy request is created from, into_branch: any # Filter by the name of the branch the deploy request will be merged into, deployed_at: any # Filter deploy requests by the date they were deployed. (e.g. 2023-01-01T00:00:00Z..2023-01-31T23:59:59Z), running_at: any # Filter deploy requests by the date they were running. (e.g. 2023-01-01T00:00:00Z..2023-01-31T23:59:59Z), page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns a list of deploy requests\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/deploy-requests\n@desc Create a deploy request\n@required {database: any # The name of the deploy request's database}\n@optional {body: map}\n@returns(201) Returns the created deploy request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/deploy-requests/{number}\n@desc Get a deploy request\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Returns information about a deploy request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/deploy-requests/{number}\n@desc Close a deploy request\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@optional {body: map}\n@returns(200) Returns the updated deploy request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/deploy-requests/{number}/apply-deploy\n@desc Complete a gated deploy request\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Returns the deploy request whose deployment has been completed\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-apply\n@desc Update auto-apply for deploy request\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@optional {body: map}\n@returns(200) Returns the deploy request whose auto-apply setting was updated\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-delete-branch\n@desc Update auto-delete branch for deploy request\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@optional {body: map}\n@returns(200) Returns the deploy request whose auto-delete branch setting was updated\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/deploy-requests/{number}/cancel\n@desc Cancel a queued deploy request\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Returns the deploy request whose deployment was canceled\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/deploy-requests/{number}/complete-deploy\n@desc Complete an errored deploy\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Returns the completed deploy request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/deploy-requests/{number}/deploy\n@desc Queue a deploy request\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@optional {body: map}\n@returns(200) Returns the deployed deploy request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/deploy-requests/{number}/deployment\n@desc Get a deployment\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Returns the deployment for a deploy request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/deploy-requests/{number}/force-cutover\n@desc Enable force cutover for a deploy request\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Returns the deploy request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/deploy-requests/{number}/operations\n@desc List deploy operations\n@required {number: any # The number of the deploy request, database: any # The name of the deploy request's database}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns deploy operations for the deploy request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/deploy-requests/{number}/revert\n@desc Complete a revert\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Returns the deploy request that was reverted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews\n@desc List deploy request reviews\n@required {database: any # The name of the database the deploy request belongs to, number: any # The number of the deploy request}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns an array of deploy request reviews\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews\n@desc Review a deploy request\n@required {database: any # The name of the database the deploy request belongs to, number: any # The number of the deploy request}\n@optional {body: map}\n@returns(201) Returns the created deploy request review\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/deploy-requests/{number}/skip-revert\n@desc Skip revert period\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Returns the deploy request whose deploy revert was skipped\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/deploy-requests/{number}/storage-check\n@desc Check deploy request storage\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Returns storage check information for the deploy request\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler\n@desc Get deploy request throttler configurations\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@returns(200) Deploy request throttler configurations\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler\n@desc Update deploy request throttler configurations\n@required {database: any # The name of the deploy request's database, number: any # The number of the deploy request}\n@optional {body: map}\n@returns(200) Deploy request throttler configurations\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/maintenance-schedules\n@desc List maintenance schedules\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns maintenance schedules for the database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/maintenance-schedules/{id}\n@desc Get a maintenance schedule\n@required {id: any # The ID of the maintenance schedule, database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@returns(200) Returns a maintenance schedule\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/maintenance-schedules/{id}/windows\n@desc List maintenance windows\n@required {id: any # The ID of the maintenance schedule, database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns maintenance windows for the schedule\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/read-only-regions\n@desc List read-only regions\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) List of the database's read-only regions\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/regions\n@desc List database regions\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns the available regions for a database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/schema-recommendations\n@desc List schema recommendations\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`.}\n@optional {state: any # Filter by recommendation state, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns schema recommendations\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/schema-recommendations/{number}\n@desc Get a schema recommendation\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., number: any # Schema recommendation sequence number. Example: `42`.}\n@returns(200) Returns a schema recommendation\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/schema-recommendations/{number}/dismiss\n@desc Dismiss a schema recommendation\n@required {database: any # Database name slug from `list_databases`. Example: `app-db`., number: any # Schema recommendation sequence number. Example: `42`.}\n@optional {body: map}\n@returns(200) Returns the dismissed schema recommendation\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/throttler\n@desc Get database throttler configurations\n@required {database: any # The name of the database that the throttled deploy requests belong to}\n@returns(200) Database throttler configurations\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/throttler\n@desc Update database throttler configurations\n@required {database: any # The name of the database that the throttled deploy requests belong to}\n@optional {body: map}\n@returns(200) Database throttler configurations\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/webhooks\n@desc List webhooks\n@required {database: any # The name of the database}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns a list of webhooks for a database\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/webhooks\n@desc Create a webhook\n@required {database: any # The name of the database}\n@optional {body: map}\n@returns(201) Returns the created webhook\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/webhooks/{id}\n@desc Get a webhook\n@required {database: any # The name of the database, id: any # The ID of the webhook}\n@returns(200) Returns the webhook\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/webhooks/{id}\n@desc Update a webhook\n@required {database: any # The name of the database, id: any # The ID of the webhook}\n@optional {body: map}\n@returns(200) Returns the updated webhook\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/webhooks/{id}\n@desc Delete a webhook\n@required {database: any # The name of the database, id: any # The ID of the webhook}\n@returns(204) Webhook successfully deleted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/webhooks/{id}/test\n@desc Test a webhook\n@required {database: any # The name of the database, id: any # The ID of the webhook}\n@returns(204) Webhook test event successfully triggered\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/workflows\n@desc List workflows\n@required {database: any # The name of the database the workflow belongs to}\n@optional {between: any # Filter workflows to those active during a time range (e.g. 2025-01-01T00:00:00Z..2025-01-01T23:59:59), page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns workflows\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/databases/{database}/workflows\n@desc Create a workflow\n@required {database: any # The name of the database the workflow belongs to}\n@optional {body: map}\n@returns(201) Returns the workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/databases/{database}/workflows/{number}\n@desc Get a workflow\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/databases/{database}/workflows/{number}\n@desc Cancel a workflow\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/workflows/{number}/complete\n@desc Complete a workflow\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/workflows/{number}/cutover\n@desc Cutover traffic\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/workflows/{number}/retry\n@desc Retry a failed workflow\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/workflows/{number}/reverse-cutover\n@desc Reverse traffic cutover\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/workflows/{number}/reverse-traffic\n@desc Reverse traffic\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/workflows/{number}/switch-primaries\n@desc Switch primary traffic\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/workflows/{number}/switch-replicas\n@desc Switch replica traffic\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/databases/{database}/workflows/{number}/verify-data\n@desc Verify workflow data\n@required {database: any # The name of the database the workflow belongs to, number: any # The sequence number of the workflow}\n@returns(200) Returns a workflow\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/invoices\n@desc Get invoices\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Gets the invoices for an organization\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/invoices/{id}\n@desc Get an invoice\n@required {id: any # Invoice public ID from `list_invoices`. Example: `aabb12123434`.}\n@returns(200) Returns an invoice\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/invoices/{id}/line-items\n@desc Get invoice line items\n@required {id: any # Invoice public ID from `list_invoices`. Example: `aabb12123434`.}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Gets the line items for an invoice\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/members\n@desc List organization members\n@optional {q: any # Search term to filter members by name or email, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns members of the organization\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/members/{id}\n@desc Get an organization member\n@required {id: any # The ID of the user}\n@returns(200) Returns the membership of the user in the organization\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/members/{id}\n@desc Update organization member role\n@required {id: any # The ID of the user}\n@optional {body: map}\n@returns(200) Returns the updated membership\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/members/{id}\n@desc Remove a member from an organization\n@required {id: any # The ID of the user}\n@optional {delete_passwords: any # Whether to delete all passwords associated with the member. Only available when removing other members (not yourself)., delete_service_tokens: any # Whether to delete all service tokens associated with the member. Only available when removing other members (not yourself).}\n@returns(204) Member removed successfully. Note: Cannot remove the last admin or leave your only organization.\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/oauth-applications\n@desc List OAuth applications\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns a list of the organization's oauth applications\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/oauth-applications/{application_id}\n@desc Get an OAuth application\n@required {application_id: any # The ID of the OAuth application}\n@returns(200) Returns information abuot an OAuth application\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/oauth-applications/{application_id}/tokens\n@desc List OAuth tokens\n@required {application_id: any # The ID of the OAuth application}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns the OAuth tokens issued on behalf of the OAuth application\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/oauth-applications/{application_id}/tokens/{token_id}\n@desc Get an OAuth token\n@required {application_id: any # The ID of the OAuth application, token_id: any # The ID of the OAuth application token}\n@returns(200) Returns an OAuth token that was issued on behalf of the OAuth application\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/oauth-applications/{application_id}/tokens/{token_id}\n@desc Delete an OAuth token\n@required {application_id: any # The ID of the OAuth application, token_id: any # The ID of the OAuth application token}\n@returns(204) Deletes an OAuth application's OAuth token\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/oauth-applications/{id}/token\n@desc Create or renew an OAuth token\n@required {id: any # The ID of the OAuth application}\n@optional {body: map}\n@returns(200) Returns the created OAuth token\n@errors {403: Forbidden, 404: Not Found, 422: Unprocessable Entity, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/regions\n@desc List regions for an organization\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns the organization's regions\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/service-tokens\n@desc List service tokens\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns the organization's service tokens\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/service-tokens\n@desc Create a service token\n@optional {body: map}\n@returns(200) Returns the created service token with the plaintext token\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/service-tokens/{id}\n@desc Get a service token\n@required {id: any # The ID of the service token}\n@returns(200) Returns the service token\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/service-tokens/{id}\n@desc Delete a service token\n@required {id: any # The ID of the service token}\n@returns(204) Service token deleted successfully\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/sso\n@desc Get organization SSO status\n@returns(200) Returns organization SSO status\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/sso\n@desc Enable organization SSO\n@returns(200) Returns organization SSO status and a domain verification URL\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/sso\n@desc Disable organization SSO\n@returns(200) Returns organization SSO status after disabling SSO\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/sso/configure\n@desc Open the SSO configuration portal\n@returns(200) Identity provider setup URL\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/sso/directory\n@desc Open the directory sync portal\n@returns(200) Directory sync setup URL\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/sso/directory\n@desc Disable directory sync\n@returns(200) Returns organization SSO status after disabling directory sync\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/sso/domains\n@desc List organization SSO domains\n@returns(200) Returns SSO domains\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/sso/domains\n@desc Start SSO domain verification\n@returns(200) Domain verification URL\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/sso/domains/{id}\n@desc Get an SSO domain\n@required {id: any # The public ID of the organization domain}\n@returns(200) Returns the SSO domain\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/sso/domains/{id}\n@desc Delete an SSO domain\n@required {id: any # The public ID of the organization domain}\n@returns(204) The domain was deleted\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/teams\n@desc List teams in an organization\n@optional {q: any # Search term to filter teams by name, page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns teams in the organization\n@errors {400: Bad Request - Invalid operation or parameters, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Validation errors or SSO-managed teams, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/teams\n@desc Create an organization team\n@optional {body: map}\n@returns(200) Returns the created team\n@errors {400: Bad Request - Invalid operation or parameters, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Validation errors or SSO-managed teams, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/teams/{team}\n@desc Get an organization team\n@required {team: any # The slug of the team}\n@returns(200) Returns the team details including members and databases\n@errors {400: Bad Request - Invalid operation or parameters, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Validation errors or SSO-managed teams, 500: Internal Server Error}\n\n@endpoint PATCH /organizations/{organization}/teams/{team}\n@desc Update an organization team\n@required {team: any # The slug of the team}\n@optional {body: map}\n@returns(200) Returns the updated team. Note: SSO-managed teams cannot be updated.\n@errors {400: Bad Request - Invalid operation or parameters, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Validation errors or SSO-managed teams, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/teams/{team}\n@desc Delete an organization team\n@required {team: any # The slug of the team}\n@returns(204) Team deleted successfully. Note: SSO-managed teams cannot be deleted.\n@errors {400: Bad Request - Invalid operation or parameters, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Validation errors or SSO-managed teams, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/teams/{team}/members\n@desc List team members\n@required {team: any # The slug of the team}\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns the list of team members\n@errors {400: Bad Request - Invalid operation or SSO-managed team, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Validation errors, 500: Internal Server Error}\n\n@endpoint POST /organizations/{organization}/teams/{team}/members\n@desc Add a member to a team\n@required {team: any # The slug of the team}\n@optional {body: map}\n@returns(200) Returns the created team membership\n@errors {400: Bad Request - Invalid operation or SSO-managed team, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Validation errors, 500: Internal Server Error}\n\n@endpoint GET /organizations/{organization}/teams/{team}/members/{id}\n@desc Get a team member\n@required {team: any # The slug of the team, id: any # The ID of the team membership or the ID of the member}\n@returns(200) Returns the team member details\n@errors {400: Bad Request - Invalid operation or SSO-managed team, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Validation errors, 500: Internal Server Error}\n\n@endpoint DELETE /organizations/{organization}/teams/{team}/members/{id}\n@desc Remove a member from a team\n@required {team: any # The slug of the team, id: any # The ID of the team membership or the ID of the member to remove}\n@optional {delete_passwords: any # Whether to delete the member's passwords created through this team}\n@returns(204) Member removed successfully. Note: SSO-managed teams cannot have members removed.\n@errors {400: Bad Request - Invalid operation or SSO-managed team, 401: Unauthorized, 403: Forbidden, 404: Not Found, 422: Unprocessable Entity - Validation errors, 500: Internal Server Error}\n\n@endgroup\n\n@group postgres-versions\n@endpoint GET /postgres-versions\n@desc List available Postgres versions\n@required {engine: any # The database engine to list Postgres versions for.}\n@returns(200) Returns the available Postgres versions\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group regions\n@endpoint GET /regions\n@desc List public regions\n@optional {page: any # If provided, specifies the page offset of returned results, per_page: any # If provided, specifies the number of returned results}\n@returns(200) Returns the available public PlanetScale regions\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group user\n@endpoint GET /user\n@desc Get current user\n@returns(200) Returns the user associated with this service token\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}