v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB

Bouncer resizes

Upsert a bouncer resize request

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 write_database

OAuth Scopes

Resource	Scopes
Organization	write_databases
Database	write_database

patch/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

Database name slug from list_databases. Example: app-db.

branchstring required

Branch name from list_branches. Example: main.

bouncerstring required

The name of the bouncer

Request body

bouncer_sizestring

The bouncer size SKU name (e.g., 'PGB_5', 'PGB_10', 'PGB_20', 'PGB_40', 'PGB_80', 'PGB_160'). Defaults to 'PGB_5'.

replicas_per_cellinteger

The number of PgBouncers per availability zone. Defaults to 1.

parametersobject

Bouncer configuration parameters nested by namespace (e.g., {"pgbouncer": {"default_pool_size": "100"}}). Use the 'List cluster parameters' endpoint to retrieve available parameters. Only parameters with namespace 'pgbouncer' can be updated.

Response

Returns bouncer resize request

idstring required

The ID of the bouncer resize

state'pending' | 'resizing' | 'canceled' | 'completed' required

The state of the bouncer resize

replicas_per_cellinteger required

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

parametersobject required

The bouncer parameters

previous_replicas_per_cellinteger required

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

previous_parametersobject required

The previous bouncer parameters

started_atstring nullable required

The time the bouncer resize started

completed_atstring nullable required

The time the bouncer resize completed

created_atstring required

The time the bouncer resize was created

updated_atstring required

The time the bouncer resize was last updated