List bouncers

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

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "sku": {
        "name": "<string>",
        "display_name": "<string>",
        "cpu": "<string>",
        "ram": 123,
        "sort_order": 123
      },
      "target": "primary",
      "replicas_per_cell": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>",
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "branch": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<string>"
      },
      "parameters": [
        {
          "id": "<string>",
          "namespace": "pgbouncer",
          "name": "<string>",
          "display_name": "<string>",
          "category": "<string>",
          "description": "<string>",
          "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>"
          }
        }
      ]
    }
  ]
}

Dedicated PgBouncers

List bouncers

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}

bouncers

List bouncers

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

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "sku": {
        "name": "<string>",
        "display_name": "<string>",
        "cpu": "<string>",
        "ram": 123,
        "sort_order": 123
      },
      "target": "primary",
      "replicas_per_cell": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>",
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "branch": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<string>"
      },
      "parameters": [
        {
          "id": "<string>",
          "namespace": "pgbouncer",
          "name": "<string>",
          "display_name": "<string>",
          "category": "<string>",
          "description": "<string>",
          "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

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

Query Parameters

page

number

default:1

If provided, specifies the page offset of returned results

per_page

number

default:25

If provided, specifies the number of returned results

Response

Returns bouncers

current_page

integer

required

The current page number

next_page

integer

required

The next page number

next_page_url

string

required

The next page of results

prev_page

integer

required

The previous page number

prev_page_url

string

required

The previous page of results

data

object[]

required

Show child attributes

data.id

string

required

The ID of the bouncer

data.name

string

required

The name of the bouncer

data.sku

object

required

Show child attributes

data.sku.name

string

required

The name of the Postgres bouncer SKU

data.sku.display_name

string

required

The display name

data.sku.cpu

string

required

The CPU allocation

data.sku.ram

integer

required

The amount of memory in bytes

data.sku.sort_order

integer

required

The sort order of the Postgres bouncer SKU

data.target

enum<string>

required

The instance type the bouncer targets

Available options:

primary,

replica,

replica_az_affinity

data.replicas_per_cell

integer

required

The count of replicas in each cell

data.created_at

string

required

When the bouncer was created

data.updated_at

string

required

When the bouncer was updated

data.deleted_at

string

required

When the bouncer was deleted

data.actor

object

required

Show child attributes

data.actor.id

string

required

The ID of the actor

data.actor.display_name

string

required

The name of the actor

data.actor.avatar_url

string

required

The URL of the actor's avatar

data.branch

object

required

Show child attributes

data.branch.id

string

required

The ID for the resource

data.branch.name

string

required

The name for the resource

data.branch.created_at

string

required

When the resource was created

data.branch.updated_at

string

required

When the resource was last updated

data.branch.deleted_at

string

required

When the resource was deleted, if deleted

data.parameters

object[]

required

Show child attributes

data.parameters.id

string

required

The ID of the parameter

data.parameters.namespace

enum<string>

required

The namespace of the parameter

Available options:

pgbouncer

data.parameters.name

string

required

The name of the parameter

data.parameters.display_name

string

required

The display name of the parameter

data.parameters.category

string

required

The category of the parameter

data.parameters.description

string

required

The description of the parameter

data.parameters.parameter_type

enum<string>

required

The type of the parameter

Available options:

array,

boolean,

bytes,

float,

integer,

internal,

seconds,

select,

string,

time

data.parameters.default_value

string

required

The default value of the parameter

data.parameters.value

string

required

The configured value of the parameter

data.parameters.required

boolean

required

Whether the parameter is required

data.parameters.created_at

string

required

When the parameter was created

data.parameters.updated_at

string

required

When the parameter was last updated

data.parameters.restart

boolean

required

True if processes require a server restart on change

data.parameters.max

number

required

The maximum value of the parameter

data.parameters.min

number

required

The minimum value of the parameter

data.parameters.step

number

required

The step change of the parameter

data.parameters.url

string

required

The URL of the parameter

data.parameters.options

string[]

required

Valid options for the parameter value

data.parameters.actor

object

required

Show child attributes

data.parameters.actor.id

string

required

The ID of the actor

data.parameters.actor.display_name

string

required

The name of the actor

data.parameters.actor.avatar_url

string

required

The URL of the actor's avatar

List cluster parameters

Create a bouncer

⌘I

Introduction

Webhooks in PlanetScale

Authentication

General API endpoints

Postgres API endpoints

Vitess API endpoints

List bouncers

Authorization

Authorizations

Path Parameters

Query Parameters

Response