Get bouncer resize requests

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

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "state": "pending",
      "replicas_per_cell": 123,
      "parameters": {},
      "previous_replicas_per_cell": 123,
      "previous_parameters": {},
      "started_at": "<string>",
      "completed_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "bouncer": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<string>"
      },
      "sku": {
        "name": "<string>",
        "display_name": "<string>",
        "cpu": "<string>",
        "ram": 123,
        "sort_order": 123
      },
      "previous_sku": {
        "name": "<string>",
        "display_name": "<string>",
        "cpu": "<string>",
        "ram": 123,
        "sort_order": 123
      }
    }
  ]
}

Dedicated PgBouncers

Get bouncer resize requests

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

{bouncer}

resizes

Get bouncer resize requests

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

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "state": "pending",
      "replicas_per_cell": 123,
      "parameters": {},
      "previous_replicas_per_cell": 123,
      "previous_parameters": {},
      "started_at": "<string>",
      "completed_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "bouncer": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<string>"
      },
      "sku": {
        "name": "<string>",
        "display_name": "<string>",
        "cpu": "<string>",
        "ram": 123,
        "sort_order": 123
      },
      "previous_sku": {
        "name": "<string>",
        "display_name": "<string>",
        "cpu": "<string>",
        "ram": 123,
        "sort_order": 123
      }
    }
  ]
}

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

bouncer

string

required

The name of the bouncer

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 bouncer resize requests

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 resize

data.state

enum<string>

required

The state of the bouncer resize

Available options:

pending,

resizing,

canceled,

completed

data.replicas_per_cell

integer

required

The number of replicas per cell for the bouncer after the resize

data.parameters

object

required

The bouncer parameters

data.previous_replicas_per_cell

integer

required

The number of replicas per cell for the bouncer before the resize

data.previous_parameters

object

required

The previous bouncer parameters

data.started_at

string

required

The time the bouncer resize started

data.completed_at

string

required

The time the bouncer resize completed

data.created_at

string

required

The time the bouncer resize was created

data.updated_at

string

required

The time the bouncer resize was last updated

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.bouncer

object

required

Show child attributes

data.bouncer.id

string

required

The ID for the resource

data.bouncer.name

string

required

The name for the resource

data.bouncer.created_at

string

required

When the resource was created

data.bouncer.updated_at

string

required

When the resource was last updated

data.bouncer.deleted_at

string

required

When the resource was deleted, if deleted

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.previous_sku

object

required

Show child attributes

data.previous_sku.name

string

required

The name of the Postgres bouncer SKU

data.previous_sku.display_name

string

required

The display name

data.previous_sku.cpu

string

required

The CPU allocation

data.previous_sku.ram

integer

required

The amount of memory in bytes

data.previous_sku.sort_order

integer

required

The sort order of the Postgres bouncer SKU

Get bouncer resize requests

Upsert a bouncer resize request

⌘I

Introduction

Webhooks in PlanetScale

Authentication

General API endpoints

Postgres API endpoints

Vitess API endpoints

Get bouncer resize requests

Authorization

Authorizations

Path Parameters

Query Parameters

Response