v17

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

Get a bouncer

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

ResourceScopes
Organizationread_branches
Databaseread_branches
Branchread_branch
get/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}

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

Response

Returns a bouncer

idstring required

The ID of the bouncer

namestring required

The name of the bouncer

target'primary' | 'replica' | 'replica_az_affinity' required

The instance type the bouncer targets

replicas_per_cellinteger required

The count of replicas in each cell

created_atstring required

When the bouncer was created

updated_atstring required

When the bouncer was updated

deleted_atstring nullable required

When the bouncer was deleted