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": "boolean",
    "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

The name of the organization that owns this resource

database
string
required

The name of the database that owns this resource

branch
string
required

The name of the branch that owns this resource

Response

Returns cluster parameters

id
string
required

The ID of the parameter

name
string
required

The name of the parameter

display_name
string
required

The display name of the parameter

namespace
enum<string>
required

The namespace of the parameter

Available options:
patroni,
pgconf,
pgbouncer
category
string
required

The category of the parameter

description
string
required

The description of the parameter

extension
boolean
required

Configures an extension

internal
boolean
required

The internal state of the parameter

parameter_type
enum<string>
required

The type of the parameter

Available options:
boolean,
bytes,
float,
integer,
internal,
milliseconds,
seconds,
select,
string,
time
default_value
string
required

The default value of the parameter

value
string
required

The configured value of the parameter

required
boolean
required

Whether the parameter is required

created_at
string
required

When the parameter was created

updated_at
string
required

When the parameter was last updated

restart
boolean
required

True if processes require a server restart on change

max
number
required

The maximum value of the parameter

min
number
required

The minimum value of the parameter

step
number
required

The step change of the parameter

url
string
required

The URL of the parameter

options
string[]
required

Valid options for the parameter value

actor
object
required