Skip to main content
PATCH
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
changes
Upsert a change request
curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/changes \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cluster_size": "<string>",
  "replicas": 123,
  "parameters": {}
}'
{
  "id": "<string>",
  "restart": [
    123
  ],
  "state": "queued",
  "started_at": "<string>",
  "completed_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "actor": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_url": "<string>"
  },
  "cluster_name": "<string>",
  "cluster_display_name": "<string>",
  "cluster_metal": true,
  "replicas": 123,
  "parameters": {},
  "previous_cluster_name": "<string>",
  "previous_cluster_display_name": "<string>",
  "previous_cluster_metal": true,
  "previous_replicas": 123,
  "previous_parameters": {},
  "minimum_storage_bytes": 123,
  "maximum_storage_bytes": 123,
  "storage_autoscaling": true,
  "storage_shrinking": true,
  "storage_type": "gp3",
  "storage_iops": 123,
  "storage_throughput_mibs": 123,
  "previous_minimum_storage_bytes": 123,
  "previous_maximum_storage_bytes": 123,
  "previous_storage_autoscaling": true,
  "previous_storage_shrinking": true,
  "previous_storage_type": "<string>",
  "previous_storage_iops": 123,
  "previous_storage_throughput_mibs": 123
}

Authorizations

Authorization
string
header
required

Path Parameters

organization
string
required
database
string
required
branch
string
required

Body

application/json
cluster_size
string
replicas
number
parameters
object

Response

id
string
required
restart
number[]
required
state
enum<string>
required
Available options:
queued,
pending,
resizing,
canceled,
completed
started_at
string
required
completed_at
string
required
created_at
string
required
updated_at
string
required
actor
object
required
cluster_name
string
required
cluster_display_name
string
required
cluster_metal
boolean
required
replicas
number
required
parameters
object
required
previous_cluster_name
string
required
previous_cluster_display_name
string
required
previous_cluster_metal
boolean
required
previous_replicas
number
required
previous_parameters
object
required
minimum_storage_bytes
number
required
maximum_storage_bytes
number
required
storage_autoscaling
boolean
required
storage_shrinking
boolean
required
storage_type
enum<string>
required
Available options:
gp3,
io2,
pd_ssd
storage_iops
number
required
storage_throughput_mibs
number
required
previous_minimum_storage_bytes
number
required
previous_maximum_storage_bytes
number
required
previous_storage_autoscaling
boolean
required
previous_storage_shrinking
boolean
required
previous_storage_type
string
required
previous_storage_iops
number
required
previous_storage_throughput_mibs
number
required