Skip to main content
GET
Get a bouncer

Authorizations

Authorization
string
header
required

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

Path Parameters

organization
string
required

Organization name slug from list_organizations. Example: acme.

database
string
required

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

branch
string
required

Branch name from list_branches. Example: main.

bouncer
string
required

The name of the bouncer

Response

Returns a bouncer

id
string
required

The ID of the bouncer

name
string
required

The name of the bouncer

sku
object
required
target
enum<string>
required

The instance type the bouncer targets

Available options:
primary,
replica,
replica_az_affinity
replicas_per_cell
integer
required

The count of replicas in each cell

created_at
string
required

When the bouncer was created

updated_at
string
required

When the bouncer was updated

deleted_at
string | null
required

When the bouncer was deleted

actor
object
required
branch
object
required
parameters
object[]
required