Skip to main content
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: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "internal": true,
    "shared_preload_allowed": true,
    "url": "<string>",
    "available": true,
    "unavailable_reason": "<string>",
    "parameters": [
      {
        "id": "<string>",
        "name": "<string>",
        "display_name": "<string>",
        "namespace": "patroni",
        "category": "<string>",
        "description": "<string>",
        "extension": true,
        "immutable": 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

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.

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

​
shared_preload_allowed
boolean
required

Whether the extension can be added to shared_preload_libraries

​
url
string
required

The URL of the extension

​
available
boolean
required

Whether the extension is available on the current cluster image

​
unavailable_reason
string
required

The reason the extension is unavailable (e.g., 'container_upgrade_required')

​
parameters
object[]
required