planetscale-api — quality + safety report

---
name: planetscale-api
description: "PlanetScale API skill. Use when working with PlanetScale for organizations, regions, user. Covers 148 endpoints."
version: 1.0.0
generator: lapsh
---

# PlanetScale API
API version: v1

## Auth
OAuth2

## Base URL
https://api.planetscale.com/v1

## Setup
1. Configure auth: OAuth2
2. GET /organizations -- verify access
3. POST /organizations/{organization}/databases -- create first databases

## Endpoints

148 endpoints across 3 groups. See references/api-spec.lap for full details.

### organizations
| Method | Path | Description |
|--------|------|-------------|
| GET | /organizations | List organizations |
| GET | /organizations/{organization} | Get an organization |
| PATCH | /organizations/{organization} | Update an organization |
| GET | /organizations/{organization}/audit-log | List audit logs |
| GET | /organizations/{organization}/cluster-size-skus | List available cluster sizes |
| GET | /organizations/{organization}/databases | List databases |
| POST | /organizations/{organization}/databases | Create a database |
| GET | /organizations/{organization}/databases/{database} | Get a database |
| PATCH | /organizations/{organization}/databases/{database} | Update database settings |
| DELETE | /organizations/{organization}/databases/{database} | Delete a database |
| GET | /organizations/{organization}/databases/{database}/branches | List branches |
| POST | /organizations/{organization}/databases/{database}/branches | Create a branch |
| GET | /organizations/{organization}/databases/{database}/branches/{branch} | Get a branch |
| PATCH | /organizations/{organization}/databases/{database}/branches/{branch} | Update a branch |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch} | Delete a branch |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/backups | List backups |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/backups | Create a backup |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/backups/{id} | Get a backup |
| PATCH | /organizations/{organization}/databases/{database}/branches/{branch}/backups/{id} | Update a backup |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch}/backups/{id} | Delete a backup |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/bouncer-resizes | Get bouncer resize requests |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/bouncers | List bouncers |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/bouncers | Create a bouncer |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer} | Get a bouncer |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer} | Delete a bouncer |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes | Get bouncer resize requests |
| PATCH | /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes | Upsert a bouncer resize request |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes | Cancel a resize request |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/changes | Get branch change requests |
| PATCH | /organizations/{organization}/databases/{database}/branches/{branch}/changes | Upsert a change request |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/changes/{id} | Get a branch change request |
| PATCH | /organizations/{organization}/databases/{database}/branches/{branch}/cluster | Change a branch cluster configuration |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/demote | Demote a branch |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/extensions | List cluster extensions |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces | Get keyspaces |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces | Create a keyspace |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace} | Get a keyspace |
| PATCH | /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace} | Configure keyspace settings |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace} | Delete a keyspace |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/rollout-status | Get keyspace rollout status |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema | Get the VSchema for the keyspace |
| PATCH | /organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema | Update the VSchema for the keyspace |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/parameters | List cluster parameters |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/passwords | List passwords |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/passwords | Create a password |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id} | Get a password |
| PATCH | /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id} | Update a password |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id} | Delete a password |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}/renew | Renew a password |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/promote | Promote a branch |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns | List generated query patterns reports |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns | Create a new query patterns report |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id} | Show the status of a query patterns report |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id} | Delete a query patterns report |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}/download | Download a finished query patterns report |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch}/resizes | Cancel a change request |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/roles | List roles |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/roles | Create role credentials |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/roles/default | Get the default postgres role |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/roles/reset-default | Reset default credentials |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id} | Get a role |
| PATCH | /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id} | Update role name |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id} | Delete role credentials |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reassign | Reassign objects owned by one role to another role |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/renew | Renew role expiration |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reset | Reset a role's password |
| POST | /organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations | Enable safe migrations for a branch |
| DELETE | /organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations | Disable safe migrations for a branch |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/schema | Get a branch schema |
| GET | /organizations/{organization}/databases/{database}/branches/{branch}/schema/lint | Lint a branch schema |
| GET | /organizations/{organization}/databases/{database}/cidrs | List IP restriction entries |
| POST | /organizations/{organization}/databases/{database}/cidrs | Create an IP restriction entry |
| GET | /organizations/{organization}/databases/{database}/cidrs/{id} | Get an IP restriction entry |
| PUT | /organizations/{organization}/databases/{database}/cidrs/{id} | Update an IP restriction entry |
| DELETE | /organizations/{organization}/databases/{database}/cidrs/{id} | Delete an IP restriction entry |
| GET | /organizations/{organization}/databases/{database}/deploy-queue | Get the deploy queue |
| GET | /organizations/{organization}/databases/{database}/deploy-requests | List deploy requests |
| POST | /organizations/{organization}/databases/{database}/deploy-requests | Create a deploy request |
| GET | /organizations/{organization}/databases/{database}/deploy-requests/{number} | Get a deploy request |
| PATCH | /organizations/{organization}/databases/{database}/deploy-requests/{number} | Close a deploy request |
| POST | /organizations/{organization}/databases/{database}/deploy-requests/{number}/apply-deploy | Complete a gated deploy request |
| PUT | /organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-apply | Update auto-apply for deploy request |
| PUT | /organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-delete-branch | Update auto-delete branch for deploy request |
| POST | /organizations/{organization}/databases/{database}/deploy-requests/{number}/cancel | Cancel a queued deploy request |
| POST | /organizations/{organization}/databases/{database}/deploy-requests/{number}/complete-deploy | Complete an errored deploy |
| POST | /organizations/{organization}/databases/{database}/deploy-requests/{number}/deploy | Queue a deploy request |
| GET | /organizations/{organization}/databases/{database}/deploy-requests/{number}/deployment | Get a deployment |
| GET | /organizations/{organization}/databases/{database}/deploy-requests/{number}/operations | List deploy operations |
| POST | /organizations/{organization}/databases/{database}/deploy-requests/{number}/revert | Complete a revert |
| GET | /organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews | List deploy request reviews |
| POST | /organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews | Review a deploy request |
| POST | /organizations/{organization}/databases/{database}/deploy-requests/{number}/skip-revert | Skip revert period |
| GET | /organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler | Get deploy request throttler configurations |
| PATCH | /organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler | Update deploy request throttler configurations |
| GET | /organizations/{organization}/databases/{database}/read-only-regions | List read-only regions |
| GET | /organizations/{organization}/databases/{database}/regions | List database regions |
| GET | /organizations/{organization}/databases/{database}/schema-recommendations | List schema recommendations |
| GET | /organizations/{organization}/databases/{database}/schema-recommendations/{number} | Get a schema recommendation |
| POST | /organizations/{organization}/databases/{database}/schema-recommendations/{number}/dismiss | Dismiss a schema recommendation |
| GET | /organizations/{organization}/databases/{database}/throttler | Get database throttler configurations |
| PATCH | /organizations/{

… (truncated)