GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
extensions
List cluster extensions
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/extensions \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "internal": true,
    "url": "<string>",
    "parameters": [
      {
        "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 extensions

id
string
required

The ID of the extension

name
string
required

The name of the extension

description
string
required

The description of the extension

internal
boolean
required

The internal state of the extension

url
string
required

The URL of the extension

parameters
object[]
required