Skip to main content
PATCH
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
cluster
Change a branch cluster configuration
curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/cluster \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cluster_size": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
organization
string
required

The name of the organization the branch belongs to

​
database
string
required

The name of the database the branch belongs to

​
branch
string
required

The name of the branch to configure

Body

application/json
​
cluster_size
string
required

The new size of the database cluster: PS_10, PS_20,…

Response

Returns an empty response body