Skip to main content
GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
parameters
List cluster parameters
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/parameters \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "namespace": "patroni",
    "category": "<string>",
    "description": "<string>",
    "extension": true,
    "internal": true,
    "parameter_type": "array",
    "default_value": "<string>",
    "value": "<string>",
    "required": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "restart": true,
    "max": 123,
    "min": 123,
    "step": 123,
    "url": "<string>",
    "options": [
      "<string>"
    ],
    "actor": {
      "id": "<string>",
      "display_name": "<string>",
      "avatar_url": "<string>"
    }
  }
]

Authorizations

Authorization
string
header
required

Path Parameters

organization
string
required
database
string
required
branch
string
required

Response

id
string
required
name
string
required
display_name
string
required
namespace
enum<string>
required
Available options:
patroni,
pgconf,
pgbouncer
category
string
required
description
string
required
extension
boolean
required
internal
boolean
required
parameter_type
enum<string>
required
Available options:
array,
boolean,
bytes,
float,
integer,
internal,
seconds,
select,
string,
time
default_value
string
required
value
string
required
required
boolean
required
created_at
string
required
updated_at
string
required
restart
boolean
required
max
number
required
min
number
required
step
number
required
url
string
required
options
string[]
required
actor
object
required