Change a branch cluster configuration

Authorization

A service token must have at least one of the following access in order to use this API endpoint:

Service Token Accesses write_database

PATCH /organizations/{organization}/databases/{database}/branches/{branch}/cluster

Change a branch cluster configuration

cURL

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>"
}
'

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

204

Returns an empty response body