{"note":"OpenAPI conversion -- returning structured metadata","name":"planetscale","description":"PlanetScale API","version":"v1","base_url":"https://api.planetscale.com/v1","endpoints":163,"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 163\n@hint download_for_search\n@toc organizations(161), 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}/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.}\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}/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\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 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}/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@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}/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 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, 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 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}/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}\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@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}\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 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 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}/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 (e.g., '1h', '24h', '7d'), 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 PUT /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 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}/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}/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 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"}