Add a member to a team.

Assign shards to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Add shards to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Cancel a change request for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Cancel a resize request. PostgreSQL databases only. This is destructive: confirm the target before calling.

Cancel a branch resize change request. Vitess/MySQL databases only. This is destructive: confirm the target before calling.

Cancel a queued deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Cancel a change request for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Cancel a change request for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Cancel a change request for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Cancel a change request for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Checks whether the deploy request's target branch cluster has enough storage to safely deploy the schema changes. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Close a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Complete an errored deploy. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Complete a gated deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Complete a revert. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Return a URL for configuring the identity provider. Requires at least one verified domain.

Create a backup.

Create a backup policy.

Create a bouncer. PostgreSQL databases only.

Create a branch.

Creates a signed token that can be used to access branch logs.

Create a database.

Create an IP restriction entry. PostgreSQL databases only.

Create a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Create an Insights agent run.

Enable SSO if needed and return a URL for verifying an email domain.

Create an organization team.

Create a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Create a hosted checkout session for adding or replacing an organization's payment method.

Create a new query patterns report.

Create a read-only replica.

Create role credentials. PostgreSQL databases only.

Create a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Add shards to a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Create a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Add a shard to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Moves the primary of a Postgres branch. On a branch with replicas the primary steps down and a replica is promoted in its place. A branch running a single instance has nothing to promote, so that instance is restarted where it stands and the branch is unreachable while it comes back. Read `method` on the response to see which one the branch got. A branch accepts one switchover at a time. A switchover that ends in the `failed` state has an unconfirmed outcome: the primary may still have moved, and nothing is rolled back. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Create a traffic budget. PostgreSQL databases only.

Create a traffic rule. PostgreSQL databases only.

Create a webhook.

Delete a backup. This is destructive: confirm the target before calling.

Delete a backup policy. This is destructive: confirm the target before calling.

Delete a bouncer. PostgreSQL databases only. This is destructive: confirm the target before calling.

Delete a branch. This is destructive: confirm the target before calling.

Delete a database. This is destructive: confirm the target before calling.

Delete an IP restriction entry. PostgreSQL databases only. This is destructive: confirm the target before calling.

Delete the current payment method for an organization. This is destructive: confirm the target before calling.

Delete a verified or pending SSO domain. This is destructive: confirm the target before calling.

Delete an organization team. This is destructive: confirm the target before calling.

Delete a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This is destructive: confirm the target before calling.

Delete a query patterns report. This is destructive: confirm the target before calling.

Delete a read-only replica. This is destructive: confirm the target before calling.

Delete role credentials. PostgreSQL databases only. This is destructive: confirm the target before calling.

Delete a router from a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Remove a shard from a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Delete a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Remove a shard from a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Remove shards from a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Delete a traffic budget. PostgreSQL databases only. This is destructive: confirm the target before calling.

Delete a traffic rule. PostgreSQL databases only. This is destructive: confirm the target before calling.

Delete a webhook. This is destructive: confirm the target before calling.

Demotes a branch from production to development. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Disable SSO and directory sync for the organization. This is destructive: confirm the target before calling.

Disable directory sync for the organization. Non-admin directory members are removed. This is destructive: confirm the target before calling.

Disable safe migrations for a branch. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This is destructive: confirm the target before calling.

Dismiss a schema recommendation.

Enable the SSO add-on and return a URL for verifying an email domain. This changes operational state and may not be safely reversible.

Return a URL for configuring directory sync. Requires SSO to be enabled.

Enable safe migrations for a branch. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Enable force cutover for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Get the admin for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a change request for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a backup.

Get a backup policy.

Get a bouncer. PostgreSQL databases only.

Get a branch.

Retrieve a branch anomaly.

Get a branch change request. PostgreSQL databases only.

Get table storage metrics by keyspace.

Retrieve time-series metrics for a database branch. ```sh curl --get \ --header "Authorization: $PLANETSCALE_SERVICE_TOKEN" \ --data-urlencode "metrics=queries" \ --data-urlencode "period=15m" \ "https://api.planetscale.com/v1/organizations/acme/databases/app-db/branches/main/metrics" ``` Each series contains its metric name, display label, identifying labels, and sampled `[Unix timestamp, value]` points: ```json { "type": "MetricSeries", "start_date": "2026-09-09T17:00:00Z", "end_date": "2026-09-09T17:15:00Z", "interval": 60, "series": [ { "type": "TimeSeries", "metric": "queries", "label": "Queries", "labels": { "tablet_type": "primary" }, "points": [[1788973200, 42.0]] } ] } ```.

Retrieve a branch query.

List queries for an error fingerprint.

Get time-series metrics for SQL queries.

Retrieve a query tag.

Get a branch resize request.

Get a branch schema. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Get table storage metrics.

Get time-series metrics grouped by query tags.

Get the user associated with the current OAuth access token.

Get a database.

Get an IP restriction entry. PostgreSQL databases only.

Get database throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Get the data topology for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get the default postgres role. PostgreSQL databases only.

Get the default shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get the deployment for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

The deploy queue returns the current list of deploy requests in the order they will be deployed. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Get a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Get deploy request throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Get an Insights agent run.

Get current metric values.

Get current tablet metrics.

Get an invoice.

Get the line items for an invoice.

Get a maintenance schedule. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Get a change request for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get an organization.

Get the current payment method for an organization.

Get an organization member by a user ID or membership ID returned by `list_organization_members`. The action uses PlanetScale's documented detail route first and falls back to the paginated member list when the provider returns 404 for an ID it just listed.

Get SSO add-on status, identity provider connection state, directory sync, and verified domains.

Get a registered SSO email domain and its verification state.

Get an organization team.

Get a team member.

Get a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Get the state of a billing payment method setup.

Download a finished query patterns report.

Show the status of a query patterns report.

Retrieve query statistics.

Retrieve a summary of query statistics.

Get a read-only replica.

Get a role. PostgreSQL databases only.

Get a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a change request for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a schema recommendation.

Get a shard for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a change request for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a shard in a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a sidecar for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a change request for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Get a switchover. PostgreSQL databases only.

Get time-series tablet metrics.

Get a traffic budget. PostgreSQL databases only.

Get a webhook.

Lint a branch schema. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

List change requests for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List parameters for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List admin size SKUs for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List audit logs.

List backup policies.

List backups.

Get bouncer resize requests. PostgreSQL databases only.

List bouncers. PostgreSQL databases only.

List branch anomalies.

Get bouncer resize requests. PostgreSQL databases only.

Get branch change requests. PostgreSQL databases only.

List branches.

List branch queries.

List branch query errors.

List query tags.

List query statistics grouped by tag.

Get branch resize requests.

List available cluster sizes for an organization.

List IP restriction entries. PostgreSQL databases only.

List database regions.

List databases.

List deploy operations for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

List deploy request reviews. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

List deploy requests for a database. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

List cluster extensions. PostgreSQL databases only.

List generated query patterns reports.

List Insights agent runs.

List Insights Agent schedules.

Get the invoices for an organization.

List maintenance schedules. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

List maintenance windows. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

List change requests for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List organization members.

When using a service token, returns the list of organizations the service token has access to. When using an OAuth token, returns the list of organizations the user has access to.

List email domains registered for organization SSO.

List team members.

List teams in an organization.

Returns the parameters for a branch. To update the parameters, use the "update_branch_change_request" endpoint. PostgreSQL databases only.

List passwords. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

List the published Postgres versions available to the requested engine. PostgreSQL databases only.

List read-only regions for the database's default branch.

Get read-only replica change requests.

List read-only replicas.

List regions for an organization.

List roles. PostgreSQL databases only.

List change requests for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List parameters for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List routers for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List router size SKUs for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List schema recommendations.

List change requests for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List extensions for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List parameters for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List shard configuration profiles for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List shards for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List shards for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List change requests for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List parameters for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List sidecars for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

List switchovers. PostgreSQL databases only.

List traffic budgets. PostgreSQL databases only.

List traffic budgets affecting a query fingerprint. PostgreSQL databases only.

List webhooks for a database.

Inspect whether the current OAuth access token is active and return its scopes and expiry.

Promotes a branch from development to production. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Queue a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Reassign objects owned by one role to another role. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Remove a member from an organization. This is destructive: confirm the target before calling.

Remove a member from a team. This is destructive: confirm the target before calling.

Renew a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Renew role expiration. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Reset default credentials. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Reset a role's password. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Review a deploy request by either approving or commenting on the deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Run maintenance for a Postgres branch. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Run maintenance for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This changes operational state and may not be safely reversible.

Run maintenance for selected Neki shard configuration profiles. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This changes operational state and may not be safely reversible.

Set the default shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Skips the revert period for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Sends a test event to the webhook. This changes operational state and may not be safely reversible.

Update the admin for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Enables or disabled the auto-apply setting for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Enables or disabled the auto-delete branch setting for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Update a backup.

Update a backup policy.

Upsert a bouncer resize request. PostgreSQL databases only.

Update a branch.

Upsert a change request for cluster size, replicas, storage, or parameters. PostgreSQL databases only.

Upsert a resize request.

Update an IP restriction entry. PostgreSQL databases only.

Update database settings.

Update database throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Set the data topology for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Update deploy request throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Update an Insights Agent schedule.

Update an organization.

Update organization member role.

Update an organization team.

Update a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Update a read-only replica.

Update role name. PostgreSQL databases only.

Update a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Update safe migrations for a branch. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Update a shard for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Update a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Update a shard in a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Update a sidecar for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Update a traffic budget. PostgreSQL databases only.

Update a webhook.