List cluster extensions

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}/extensions

List cluster extensions

cURL

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

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "internal": true,
    "shared_preload_allowed": true,
    "url": "<string>",
    "parameters": [
      {
        "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

The access token received from the authorization server in the OAuth 2.0 flow.

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

200

application/json

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

parameters · object[] · required

Show child attributes