List parameters for an admin

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 read_branch, delete_branch, create_branch, connect_production_branch, connect_branch

OAuth Scopes

Resource	Scopes
Organization	read_branches
Database	read_branches
Branch	read_branch

GET /organizations/{organization}/databases/{database}/branches/{branch}/admin/parameters

List parameters for a Neki admin

cURL

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/admin/parameters \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "name": "<string>",
    "display_name": "<string>",
    "namespace": "admin",
    "advanced": true,
    "internal": true,
    "category": "<string>",
    "description": "<string>",
    "parameter_type": "array",
    "default_value": "<string>",
    "disabled": true,
    "requires_update": "cluster",
    "value": "<string>",
    "required": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "restart": true,
    "url": "<string>",
    "actor": {
      "id": "<string>",
      "display_name": "<string>",
      "avatar_url": "<string>"
    },
    "id": "<string>",
    "max": "<string>",
    "min": "<string>",
    "options": [
      "<string>"
    ],
    "units": [
      "<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.

Query Parameters

internal · boolean

Set to true to return only internal parameters, which cannot be changed. Set to false to return only parameters you can change. Omit to return both.

Response

200

application/json

Returns parameters for the admin

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: admin, pgconf, replicator, router, sidecar

advanced · boolean · required

Whether the parameter is advanced

internal · boolean · required

Whether the parameter is internal and cannot be changed

category · string | null · required

The category of the parameter

description · string · required

The description of the parameter

parameter_type · enum<string> · required

The type of the parameter

Available options: array, boolean, bytes, float, integer, select, string, time

default_value · string | null · required

The default value of the parameter

disabled · boolean · required

Whether the parameter is disabled

requires_update · enum<string> | null · required

The update required before the parameter can be configured

Available options: cluster, configuration_profile

value · string | null · required

The configured value of the parameter

required · boolean · required

Whether the parameter is required

created_at · string | null · required

When the parameter was created

updated_at · string | null · required

When the parameter was last updated

restart · boolean · required

Whether processes require a server restart after the parameter changes

url · string · required

The URL of the parameter

actor · object · required

Show child attributes

id · string | null

The ID of the parameter

max · string | null

The maximum value of the parameter, e.g. 800 or 1h

min · string | null

The minimum value of the parameter, e.g. 0 or 1ms

options · string[] | null

Options, including disabled ones, for the parameter value. Null means unset

units · string[] | null

The units of the parameter value