api-anomalies2

api-branch_bouncer_resizes1

api-branch_maintenances1

api-branch_resizes3

api-query_insights4

api-query_insights_errors2

api-query_insights_tags3

api-query_insights_traffic_budgets1

api-read_only_replica_changes1

BackupPolicies5

Backups5

Billing payment method2

Billing payment method setup2

Bouncer resizes3

Bouncers4

Branch changes4

Cluster extensions1

Cluster parameters1

Database branch keyspaces6

Database branch passwords6

Database branches13

Database Postgres IP restrictions5

Databases9

Deploy requests21

Invoices3

Keyspace resizes4

Keyspace VSchemas2

MaintenanceSchedules2

MaintenanceWindows1

Metrics8

OAuth applications5

OAuth tokens1

Organization members4

Organization SSO6

Organization SSO domains4

Organization teams5

Organizations6

Query Insights reports5

Read-only replicas4

Regions1

Roles10

Schema recommendations3

Service tokens4

Switchovers3

Team members4

Traffic budgets5

Traffic rules2

Users1

Webhooks6

Workflows12

Bouncers

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

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.

Query parameters

pageinteger

If provided, specifies the page offset of returned results

per_pageinteger

If provided, specifies the number of returned results

Response

Returns bouncers

typestring required

The response type. Always "list" for paginated responses.

current_pageinteger required

The current page number

per_pageinteger required

The maximum number of results per page

next_pageinteger nullable required

The next page number, or null when this is the last page

next_page_urlstring nullable required

The next page of results, or null when this is the last page

prev_pageinteger nullable required

The previous page number, or null when this is the first page

prev_page_urlstring nullable required

The previous page of results, or null when this is the first page

Changes

Changed in 8 of the 24 revisions of this API.9211

Aug 18, 20262499429954891See the full diff
- ▲
  removed the required property data/items/parameters/items/step from the response with the 200 status
  response-required-property-removed
Aug 11, 20264b2e4f05bda21See the full diff
- ○
  added the required property per_page to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 1, 202672506953f36761See the full diff
- ▲
  the response property data/items/branch/deleted_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/deleted_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property next_page became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property next_page_url became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property prev_page became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property prev_page_url became nullable for the status 200
  response-property-became-nullable
- ○
  added the required property type to the response with the 200 status
  response-required-property-added
Feb 24, 20263c33e46f8ff212See the full diff
- ●
  added the new string enum value to the data/items/parameters/items/parameter_type response property for the response status 200
  response-property-enum-value-added
- ○
  removed the internal enum value from the data/items/parameters/items/parameter_type response property for the response status 200
  response-property-enum-value-removed
- ○
  added the required property data/items/parameters/items/immutable to the response with the 200 status
  response-required-property-added
Feb 10, 2026ed1825db11c65See the full diff
- ○
  removed the boolean enum value from the data/items/parameters/items/parameter_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the bytes enum value from the data/items/parameters/items/parameter_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the float enum value from the data/items/parameters/items/parameter_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the string enum value from the data/items/parameters/items/parameter_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the time enum value from the data/items/parameters/items/parameter_type response property for the response status 200
  response-property-enum-value-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 9, 2025d710019068fb2See the full diff
- ▲
  for the query request parameter page, the type/format was changed from number/ to integer/
  request-parameter-type-changed
- ▲
  for the query request parameter per_page, the type/format was changed from number/ to integer/
  request-parameter-type-changed
Nov 15, 2025be036c71496f1See the full diff
- ○
  removed the milliseconds enum value from the data/items/parameters/items/parameter_type response property for the response status 200
  response-property-enum-value-removed
Nov 14, 20255f2529ef1c8611See the full diff
- ●
  added the new replica_az_affinity enum value to the data/items/target response property for the response status 200
  response-property-enum-value-added
- ○
  added the required property data/items/sku to the response with the 200 status
  response-required-property-added

Full history