Update a configuration profile for a Neki branch

curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cluster_size": "<string>",
  "extensions": [
    "<string>"
  ],
  "replicas": 123,
  "parameters": {},
  "postgres_major_version": "<string>",
  "postgres_minor_version": "<string>",
  "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}/configuration-profiles/{configuration_profile}"

payload = {
    "name": "<string>",
    "cluster_size": "<string>",
    "extensions": ["<string>"],
    "replicas": 123,
    "parameters": {},
    "postgres_major_version": "<string>",
    "postgres_minor_version": "<string>",
    "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({
    name: '<string>',
    cluster_size: '<string>',
    extensions: ['<string>'],
    replicas: 123,
    parameters: {},
    postgres_major_version: '<string>',
    postgres_minor_version: '<string>',
    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}/configuration-profiles/{configuration_profile}', 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}/configuration-profiles/{configuration_profile}",
  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([
    'name' => '<string>',
    'cluster_size' => '<string>',
    'extensions' => [
        '<string>'
    ],
    'replicas' => 123,
    'parameters' => [
        
    ],
    'postgres_major_version' => '<string>',
    'postgres_minor_version' => '<string>',
    '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}/configuration-profiles/{configuration_profile}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"cluster_size\": \"<string>\",\n  \"extensions\": [\n    \"<string>\"\n  ],\n  \"replicas\": 123,\n  \"parameters\": {},\n  \"postgres_major_version\": \"<string>\",\n  \"postgres_minor_version\": \"<string>\",\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}/configuration-profiles/{configuration_profile}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"cluster_size\": \"<string>\",\n  \"extensions\": [\n    \"<string>\"\n  ],\n  \"replicas\": 123,\n  \"parameters\": {},\n  \"postgres_major_version\": \"<string>\",\n  \"postgres_minor_version\": \"<string>\",\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}/configuration-profiles/{configuration_profile}")

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  \"name\": \"<string>\",\n  \"cluster_size\": \"<string>\",\n  \"extensions\": [\n    \"<string>\"\n  ],\n  \"replicas\": 123,\n  \"parameters\": {},\n  \"postgres_major_version\": \"<string>\",\n  \"postgres_minor_version\": \"<string>\",\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>",
  "architecture": "<string>",
  "cluster_size": "<string>",
  "cluster_display_name": "<string>",
  "default": true,
  "metal": true,
  "replicas": 123,
  "postgres_image_version": "<string>",
  "latest_postgres_image_version": "<string>",
  "postgres_major_version": 123,
  "postgres_minor_version": 123,
  "latest_postgres_minor_version": 123,
  "shards": 123,
  "storage": {
    "minimum_storage_bytes": 123,
    "maximum_storage_bytes": 123,
    "storage_autoscaling": true,
    "storage_iops": 123,
    "storage_throughput_mibs": 123
  },
  "state": "draft",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Configuration profiles

Update a configuration profile for a branch

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}

configuration-profiles

{configuration_profile}

Update a configuration profile for a Neki branch

curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/configuration-profiles/{configuration_profile} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cluster_size": "<string>",
  "extensions": [
    "<string>"
  ],
  "replicas": 123,
  "parameters": {},
  "postgres_major_version": "<string>",
  "postgres_minor_version": "<string>",
  "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}/configuration-profiles/{configuration_profile}"

payload = {
    "name": "<string>",
    "cluster_size": "<string>",
    "extensions": ["<string>"],
    "replicas": 123,
    "parameters": {},
    "postgres_major_version": "<string>",
    "postgres_minor_version": "<string>",
    "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({
    name: '<string>',
    cluster_size: '<string>',
    extensions: ['<string>'],
    replicas: 123,
    parameters: {},
    postgres_major_version: '<string>',
    postgres_minor_version: '<string>',
    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}/configuration-profiles/{configuration_profile}', 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}/configuration-profiles/{configuration_profile}",
  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([
    'name' => '<string>',
    'cluster_size' => '<string>',
    'extensions' => [
        '<string>'
    ],
    'replicas' => 123,
    'parameters' => [
        
    ],
    'postgres_major_version' => '<string>',
    'postgres_minor_version' => '<string>',
    '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}/configuration-profiles/{configuration_profile}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"cluster_size\": \"<string>\",\n  \"extensions\": [\n    \"<string>\"\n  ],\n  \"replicas\": 123,\n  \"parameters\": {},\n  \"postgres_major_version\": \"<string>\",\n  \"postgres_minor_version\": \"<string>\",\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}/configuration-profiles/{configuration_profile}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"cluster_size\": \"<string>\",\n  \"extensions\": [\n    \"<string>\"\n  ],\n  \"replicas\": 123,\n  \"parameters\": {},\n  \"postgres_major_version\": \"<string>\",\n  \"postgres_minor_version\": \"<string>\",\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}/configuration-profiles/{configuration_profile}")

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  \"name\": \"<string>\",\n  \"cluster_size\": \"<string>\",\n  \"extensions\": [\n    \"<string>\"\n  ],\n  \"replicas\": 123,\n  \"parameters\": {},\n  \"postgres_major_version\": \"<string>\",\n  \"postgres_minor_version\": \"<string>\",\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>",
  "architecture": "<string>",
  "cluster_size": "<string>",
  "cluster_display_name": "<string>",
  "default": true,
  "metal": true,
  "replicas": 123,
  "postgres_image_version": "<string>",
  "latest_postgres_image_version": "<string>",
  "postgres_major_version": 123,
  "postgres_minor_version": 123,
  "latest_postgres_minor_version": 123,
  "shards": 123,
  "storage": {
    "minimum_storage_bytes": 123,
    "maximum_storage_bytes": 123,
    "storage_autoscaling": true,
    "storage_iops": 123,
    "storage_throughput_mibs": 123
  },
  "state": "draft",
  "created_at": "<string>",
  "updated_at": "<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

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.

configuration_profile

string

required

Name from list_shard_configuration_profiles.

Body

application/json

name

string

The new name for the configuration profile

cluster_size

string

The new cluster size for the configuration profile

extensions

string[]

Extensions to enable. This replaces the current set; omit it to leave them unchanged.

replicas

integer

The new number of replicas for the configuration profile

parameters

object

Configuration profile parameters nested by namespace (e.g., {"pgconf": {"max_connections": "200"}}).

postgres_major_version

string

The PostgreSQL major version for the configuration profile

postgres_minor_version

string

The PostgreSQL minor version for the configuration profile. Requires postgres_major_version when specified.

storage

object

Show child attributes

Response

Returns the updated configuration profile

string

required

The ID of the configuration profile

name

string

required

The name of the configuration profile

architecture

string

required

The architecture of the cluster size SKU

cluster_size

string

required

The name of the cluster size SKU

cluster_display_name

string

required

The display name of the cluster size SKU

default

boolean

required

Whether this is the default configuration profile

metal

boolean

required

Whether shards using this configuration profile use metal instances

replicas

integer

required

The number of replicas for shards using this configuration profile

postgres_image_version

string

required

The PostgreSQL image used by the configuration profile

latest_postgres_image_version

string

required

The latest PostgreSQL image available to the configuration profile

postgres_major_version

integer

required

The PostgreSQL major version used by the configuration profile

postgres_minor_version

integer

required

The PostgreSQL minor version used by the configuration profile

latest_postgres_minor_version

integer

required

The latest PostgreSQL minor version available to the configuration profile

shards

integer

required

The number of shards using this configuration profile

storage

object

required

Show child attributes

state

enum<string>

required

The current state of the configuration profile

Available options:

draft,

pending,

applying,

ready

created_at

string

required

When the configuration profile was created

updated_at

string

required

When the configuration profile was last updated

Introduction

Webhooks in PlanetScale

Authentication

General API endpoints

Postgres API endpoints

Neki API endpoints

Vitess API endpoints

Update a configuration profile for a branch

Authorization

Authorizations

Path Parameters

Body

Response