List branches

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "type": "<string>",
  "current_page": 123,
  "per_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "total_count": 123,
  "total_pages": 123,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>",
      "restore_checklist_completed_at": "<string>",
      "schema_last_updated_at": "<string>",
      "kind": "mysql",
      "state": "pending",
      "cluster_name": "<string>",
      "cluster_iops": 123,
      "ready": true,
      "metal": true,
      "production": true,
      "safe_migrations": true,
      "deletion_protected": true,
      "sharded": true,
      "keyspace_count": 123,
      "stale_schema": true,
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "restored_from_branch": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<string>"
      },
      "private_edge_connectivity": true,
      "has_replicas": true,
      "has_read_only_replicas": true,
      "html_url": "<string>",
      "url": "<string>",
      "region": {
        "id": "<string>",
        "provider": "<string>",
        "enabled": true,
        "public_ip_addresses": [
          "<string>"
        ],
        "display_name": "<string>",
        "location": "<string>",
        "slug": "<string>",
        "current_default": true,
        "mysql_supported": true,
        "postgresql_supported": true,
        "neki_supported": true
      },
      "parent_branch": "<string>",
      "mysql_address": "<string>",
      "mysql_edge_address": "<string>",
      "direct_vtgate": true,
      "vtgate_size": "<string>",
      "vtgate_name": "<string>",
      "vtgate_count": 123,
      "vtgate_autoscaling": true,
      "vtgate_max_count": 123,
      "vtgate_target_cpu_utilization": 123,
      "schema_ready": true,
      "shard_count": 123,
      "vtgate_options": {}
    }
  ]
}

Database branches

List branches

Authorization

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

Service Token Accesses read_branch, delete_branch, create_branch, connect_production_branch, connect_branch

OAuth Scopes

Resource	Scopes
Organization	`read_branches`
Database	`read_branches`
Branch	`read_branch`

GET

organizations

{organization}

databases

{database}

branches

List branches

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "type": "<string>",
  "current_page": 123,
  "per_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "total_count": 123,
  "total_pages": 123,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>",
      "restore_checklist_completed_at": "<string>",
      "schema_last_updated_at": "<string>",
      "kind": "mysql",
      "state": "pending",
      "cluster_name": "<string>",
      "cluster_iops": 123,
      "ready": true,
      "metal": true,
      "production": true,
      "safe_migrations": true,
      "deletion_protected": true,
      "sharded": true,
      "keyspace_count": 123,
      "stale_schema": true,
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "restored_from_branch": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<string>"
      },
      "private_edge_connectivity": true,
      "has_replicas": true,
      "has_read_only_replicas": true,
      "html_url": "<string>",
      "url": "<string>",
      "region": {
        "id": "<string>",
        "provider": "<string>",
        "enabled": true,
        "public_ip_addresses": [
          "<string>"
        ],
        "display_name": "<string>",
        "location": "<string>",
        "slug": "<string>",
        "current_default": true,
        "mysql_supported": true,
        "postgresql_supported": true,
        "neki_supported": true
      },
      "parent_branch": "<string>",
      "mysql_address": "<string>",
      "mysql_edge_address": "<string>",
      "direct_vtgate": true,
      "vtgate_size": "<string>",
      "vtgate_name": "<string>",
      "vtgate_count": 123,
      "vtgate_autoscaling": true,
      "vtgate_max_count": 123,
      "vtgate_target_cpu_utilization": 123,
      "schema_ready": true,
      "shard_count": 123,
      "vtgate_options": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

FlowAuthorization Code

Authorization URL: https://app.planetscale.com/oauth/authorize
Token URL: https://auth.planetscale.com/oauth/token

Path Parameters

organization

string

required

Organization name slug from list_organizations. Example: acme.

database

string

required

Database name slug from list_databases. Example: app-db.

Query Parameters

string

Search branches by name

production

boolean

Filter branches by production status

safe_migrations

boolean

Filter branches by safe migrations (DDL protection)

order

enum<string>

Order branches by created_at time

Available options:

asc,

desc

page

integer

default:1

If provided, specifies the page offset of returned results

per_page

integer

default:25

If provided, specifies the number of returned results

Response

Returns database branches

type

string

required

The response type. Always "list" for paginated responses.

current_page

integer

required

The current page number

per_page

integer

required

The maximum number of results per page

next_page

integer | null

required

The next page number, or null when this is the last page

next_page_url

string | null

required

The next page of results, or null when this is the last page

prev_page

integer | null

required

The previous page number, or null when this is the first page

prev_page_url

string | null

required

The previous page of results, or null when this is the first page

total_count

integer

required

The total number of matching results

total_pages

integer

required

The total number of pages of matching results

data

object[]

required

Show child attributes

Introduction

Webhooks in PlanetScale

Authentication

General API endpoints

Postgres API endpoints

Neki API endpoints

Vitess API endpoints

List branches

Authorization

Authorizations

Path Parameters

Query Parameters

Response