Skip to main content
GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
changes
Get branch change requests
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/changes \
  --header 'Authorization: <api-key>'
{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "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

Query Parameters

page
number
default:1
per_page
number
default:25

Response

current_page
number
required
next_page
number
required
next_page_url
string
required
prev_page
number
required
prev_page_url
string
required
data
object[]
required