Create a router for a Neki branch

curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/routers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "router_size": "<string>",
  "replicas_per_cell": 123
}
'

import requests

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

payload = {
    "name": "<string>",
    "router_size": "<string>",
    "replicas_per_cell": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', router_size: '<string>', replicas_per_cell: 123})
};

fetch('https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/routers', 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}/routers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'router_size' => '<string>',
    'replicas_per_cell' => 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}/routers"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"router_size\": \"<string>\",\n  \"replicas_per_cell\": 123\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/routers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"router_size\": \"<string>\",\n  \"replicas_per_cell\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"router_size\": \"<string>\",\n  \"replicas_per_cell\": 123\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "default": true,
  "sku": {
    "name": "<string>",
    "display_name": "<string>",
    "cpu": "<string>",
    "ram": 123,
    "sort_order": 123,
    "rate": 123,
    "enabled": true
  },
  "router_size": "<string>",
  "replicas_per_cell": 123,
  "autoscaling": true,
  "max_replicas_per_cell": 123,
  "target_cpu_utilization": 123,
  "state": "pending",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Routers

Create a router 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`

POST

organizations

{organization}

databases

{database}

branches

{branch}

routers

Create a router for a Neki branch

curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/routers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "router_size": "<string>",
  "replicas_per_cell": 123
}
'

import requests

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

payload = {
    "name": "<string>",
    "router_size": "<string>",
    "replicas_per_cell": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', router_size: '<string>', replicas_per_cell: 123})
};

fetch('https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/routers', 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}/routers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'router_size' => '<string>',
    'replicas_per_cell' => 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}/routers"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"router_size\": \"<string>\",\n  \"replicas_per_cell\": 123\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/routers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"router_size\": \"<string>\",\n  \"replicas_per_cell\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"router_size\": \"<string>\",\n  \"replicas_per_cell\": 123\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "default": true,
  "sku": {
    "name": "<string>",
    "display_name": "<string>",
    "cpu": "<string>",
    "ram": 123,
    "sort_order": 123,
    "rate": 123,
    "enabled": true
  },
  "router_size": "<string>",
  "replicas_per_cell": 123,
  "autoscaling": true,
  "max_replicas_per_cell": 123,
  "target_cpu_utilization": 123,
  "state": "pending",
  "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.

Body

application/json

name

string

required

The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router.

router_size

string

The router size SKU, e.g. NKR_1. Defaults to the service's default size.

replicas_per_cell

integer

The number of router instances per availability zone. Defaults to the service's default count.

Response

Returns the created router

string

required

The ID of the router

name

string

required

The name of the router

default

boolean

required

Whether this is the default router

sku

object

required

Show child attributes

router_size

string

required

The router size SKU name

replicas_per_cell

integer

required

The count of replicas in each cell

autoscaling

boolean

required

Whether the router scales horizontally within each cell

max_replicas_per_cell

integer | null

required

The maximum count of replicas in each cell when autoscaling

target_cpu_utilization

integer | null

required

The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70

state

enum<string>

required

The current state of the router

Available options:

pending,

applying,

ready

created_at

string

required

When the router was created

updated_at

string

required

When the router was last updated

Introduction

Webhooks in PlanetScale

Authentication

General API endpoints

Postgres API endpoints

Neki API endpoints

Vitess API endpoints

Create a router for a branch

Authorization

Authorizations

Path Parameters

Body

Response