Update a dedicated read replica

curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "replicas": 123,
  "cluster_size": "<string>",
  "parameters": {},
  "storage": {
    "minimum_storage_bytes": 123,
    "maximum_storage_bytes": 123,
    "storage_autoscaling": true,
    "storage_iops": 123,
    "storage_throughput_mibs": 123
  }
}
'

import requests

url = "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}"

payload = {
    "replicas": 123,
    "cluster_size": "<string>",
    "parameters": {},
    "storage": {
        "minimum_storage_bytes": 123,
        "maximum_storage_bytes": 123,
        "storage_autoscaling": True,
        "storage_iops": 123,
        "storage_throughput_mibs": 123
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    replicas: 123,
    cluster_size: '<string>',
    parameters: {},
    storage: {
      minimum_storage_bytes: 123,
      maximum_storage_bytes: 123,
      storage_autoscaling: true,
      storage_iops: 123,
      storage_throughput_mibs: 123
    }
  })
};

fetch('https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}', 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/{branch}/dedicated-read-replicas/{dedicated_read_replica}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'replicas' => 123,
    'cluster_size' => '<string>',
    'parameters' => [
        
    ],
    'storage' => [
        'minimum_storage_bytes' => 123,
        'maximum_storage_bytes' => 123,
        'storage_autoscaling' => true,
        'storage_iops' => 123,
        'storage_throughput_mibs' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}"

	payload := strings.NewReader("{\n  \"replicas\": 123,\n  \"cluster_size\": \"<string>\",\n  \"parameters\": {},\n  \"storage\": {\n    \"minimum_storage_bytes\": 123,\n    \"maximum_storage_bytes\": 123,\n    \"storage_autoscaling\": true,\n    \"storage_iops\": 123,\n    \"storage_throughput_mibs\": 123\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"replicas\": 123,\n  \"cluster_size\": \"<string>\",\n  \"parameters\": {},\n  \"storage\": {\n    \"minimum_storage_bytes\": 123,\n    \"maximum_storage_bytes\": 123,\n    \"storage_autoscaling\": true,\n    \"storage_iops\": 123,\n    \"storage_throughput_mibs\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"replicas\": 123,\n  \"cluster_size\": \"<string>\",\n  \"parameters\": {},\n  \"storage\": {\n    \"minimum_storage_bytes\": 123,\n    \"maximum_storage_bytes\": 123,\n    \"storage_autoscaling\": true,\n    \"storage_iops\": 123,\n    \"storage_throughput_mibs\": 123\n  }\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "state": "<string>",
  "replicas": 123,
  "cluster_name": "<string>",
  "cluster_display_name": "<string>",
  "access_host_url": "<string>",
  "private_access_host_url": "<string>",
  "private_connection_service_name": "<string>",
  "minimum_storage_bytes": 123,
  "maximum_storage_bytes": 123,
  "storage_autoscaling": true,
  "storage_type": "gp3",
  "storage_iops": 123,
  "storage_throughput_mibs": 123,
  "volume_modifications_blocked_until": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "ready_at": "<string>",
  "ready": true,
  "actor": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_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
  },
  "parameters": [
    {
      "id": "<string>",
      "namespace": "pgconf",
      "name": "<string>",
      "display_name": "<string>",
      "category": "<string>",
      "description": "<string>",
      "immutable": true,
      "parameter_type": "integer",
      "default_value": "<string>",
      "value": "<string>",
      "required": true,
      "created_at": "<string>",
      "updated_at": "<string>",
      "restart": true,
      "max": 123,
      "min": 123,
      "url": "<string>",
      "options": [
        "<string>"
      ],
      "units": [
        "<string>"
      ],
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "disabled_reason": "<string>"
    }
  ]
}

Dedicated read replicas

Update a dedicated read replica

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 write_database

OAuth Scopes

Resource	Scopes
Organization	`write_databases`
Database	`write_database`

PATCH

organizations

{organization}

databases

{database}

branches

{branch}

dedicated-read-replicas

{dedicated_read_replica}

Update a dedicated read replica

curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "replicas": 123,
  "cluster_size": "<string>",
  "parameters": {},
  "storage": {
    "minimum_storage_bytes": 123,
    "maximum_storage_bytes": 123,
    "storage_autoscaling": true,
    "storage_iops": 123,
    "storage_throughput_mibs": 123
  }
}
'

import requests

url = "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}"

payload = {
    "replicas": 123,
    "cluster_size": "<string>",
    "parameters": {},
    "storage": {
        "minimum_storage_bytes": 123,
        "maximum_storage_bytes": 123,
        "storage_autoscaling": True,
        "storage_iops": 123,
        "storage_throughput_mibs": 123
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    replicas: 123,
    cluster_size: '<string>',
    parameters: {},
    storage: {
      minimum_storage_bytes: 123,
      maximum_storage_bytes: 123,
      storage_autoscaling: true,
      storage_iops: 123,
      storage_throughput_mibs: 123
    }
  })
};

fetch('https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}', 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/{branch}/dedicated-read-replicas/{dedicated_read_replica}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'replicas' => 123,
    'cluster_size' => '<string>',
    'parameters' => [
        
    ],
    'storage' => [
        'minimum_storage_bytes' => 123,
        'maximum_storage_bytes' => 123,
        'storage_autoscaling' => true,
        'storage_iops' => 123,
        'storage_throughput_mibs' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}"

	payload := strings.NewReader("{\n  \"replicas\": 123,\n  \"cluster_size\": \"<string>\",\n  \"parameters\": {},\n  \"storage\": {\n    \"minimum_storage_bytes\": 123,\n    \"maximum_storage_bytes\": 123,\n    \"storage_autoscaling\": true,\n    \"storage_iops\": 123,\n    \"storage_throughput_mibs\": 123\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"replicas\": 123,\n  \"cluster_size\": \"<string>\",\n  \"parameters\": {},\n  \"storage\": {\n    \"minimum_storage_bytes\": 123,\n    \"maximum_storage_bytes\": 123,\n    \"storage_autoscaling\": true,\n    \"storage_iops\": 123,\n    \"storage_throughput_mibs\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/dedicated-read-replicas/{dedicated_read_replica}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"replicas\": 123,\n  \"cluster_size\": \"<string>\",\n  \"parameters\": {},\n  \"storage\": {\n    \"minimum_storage_bytes\": 123,\n    \"maximum_storage_bytes\": 123,\n    \"storage_autoscaling\": true,\n    \"storage_iops\": 123,\n    \"storage_throughput_mibs\": 123\n  }\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "state": "<string>",
  "replicas": 123,
  "cluster_name": "<string>",
  "cluster_display_name": "<string>",
  "access_host_url": "<string>",
  "private_access_host_url": "<string>",
  "private_connection_service_name": "<string>",
  "minimum_storage_bytes": 123,
  "maximum_storage_bytes": 123,
  "storage_autoscaling": true,
  "storage_type": "gp3",
  "storage_iops": 123,
  "storage_throughput_mibs": 123,
  "volume_modifications_blocked_until": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "ready_at": "<string>",
  "ready": true,
  "actor": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_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
  },
  "parameters": [
    {
      "id": "<string>",
      "namespace": "pgconf",
      "name": "<string>",
      "display_name": "<string>",
      "category": "<string>",
      "description": "<string>",
      "immutable": true,
      "parameter_type": "integer",
      "default_value": "<string>",
      "value": "<string>",
      "required": true,
      "created_at": "<string>",
      "updated_at": "<string>",
      "restart": true,
      "max": 123,
      "min": 123,
      "url": "<string>",
      "options": [
        "<string>"
      ],
      "units": [
        "<string>"
      ],
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "disabled_reason": "<string>"
    }
  ]
}

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.

branch

string

required

Branch name from list_branches. Example: main.

dedicated_read_replica

string

required

The name of the dedicated read replica

Body

application/json

replicas

integer

The number of instances serving reads

cluster_size

string

The cluster size SKU name

parameters

object

Configuration parameters nested by namespace (e.g., {"pgconf": {"max_connections": "300"}}). Values must be greater than or equal to the primary's.

storage

object

Show child attributes

Response

Returns the updated dedicated read replica

string

required

The ID of the dedicated read replica

name

string

required

The name of the dedicated read replica

state

string

required

The state of the dedicated read replica: pending, ready, or deleting

replicas

integer

required

The number of instances serving reads in this dedicated read replica

cluster_name

string

required

The SKU representing the cluster size of the dedicated read replica

cluster_display_name

string

required

The SKU representing the cluster size of the dedicated read replica, for display

access_host_url

string

required

The database connection host for the dedicated read replica

private_access_host_url

string

required

The private database connection host for the dedicated read replica

private_connection_service_name

string | null

required

The service name to set up private connectivity for the dedicated read replica

minimum_storage_bytes

integer | null

required

The minimum storage size in bytes

maximum_storage_bytes

integer | null

required

The maximum storage size in bytes

storage_autoscaling

boolean | null

required

Whether storage autoscaling is enabled

storage_type

enum<string> | null

required

The storage type

Available options:

gp3,

io2,

pd_ssd,

hyperdisk_balanced,

premium_v2_lrs

storage_iops

integer | null

required

The storage IOPS

storage_throughput_mibs

integer | null

required

The storage throughput in MiB/s

volume_modifications_blocked_until

string | null

required

When volume modifications will be allowed again

created_at

string

required

When the dedicated read replica was created

updated_at

string

required

When the dedicated read replica was last updated

ready_at

string | null

required

When the dedicated read replica was ready to serve queries

ready

boolean

required

Whether or not the dedicated read replica is ready to serve queries

actor

object

required

Show child attributes

region

object

required

Show child attributes

parameters

object[]

required

Show child attributes

Introduction

Webhooks in PlanetScale

Authentication

General API endpoints

Postgres API endpoints

Neki API endpoints

Vitess API endpoints

Update a dedicated read replica

Authorization

Authorizations

Path Parameters

Body

Response