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

Backups

List backups

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_backups

OAuth Scopes

Resource	Scopes
Organization	read_backups
Database	read_backups
Branch	read_backups

get/organizations/{organization}/databases/{database}/branches/{branch}/backups

Path parameters

organizationstring required

The name of the organization the branch belongs to

databasestring required

The name of the database the branch belongs to

branchstring required

The name of the branch

Query parameters

allboolean

Whether to include all backups, including deleted ones

Filter backups by state

policystring

Filter backups by backup policy ID

fromstring

Filter backups started after this date (e.g. 2023-01-01T00:00:00Z)

tostring

Filter backups started before this date (e.g. 2023-01-31T23:59:59Z)

running_atstring

Filter backups that are running during a specific time (e.g. 2023-01-01T00:00:00Z..2023-01-01T23:59:59Z)

productionboolean

Filter backups by production branch

pageinteger

If provided, specifies the page offset of returned results

per_pageinteger

If provided, specifies the number of returned results

Response

Returns database branch backups

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

total_countinteger required

The total number of matching results

total_pagesinteger required

The total number of pages of matching results

Changes

Changed in 6 of the 24 revisions of this API.2617

Aug 18, 20262499429954892See the full diff
- ○
  added the required property total_count to the response with the 200 status
  response-required-property-added
- ○
  added the required property total_pages to the response with the 200 status
  response-required-property-added
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
Jul 8, 2026fa19f33052411See the full diff
- ○
  added the required property data/items/uncompressed_size to the response with the 200 status
  response-required-property-added
Jun 1, 202672506953f367222See the full diff
- ▲
  the response property data/items/actor became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/backup_policy became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/backup_policy/last_ran_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/backup_policy/next_run_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/backup_policy/schedule_day became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/backup_policy/schedule_week became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/completed_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/database_branch became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/database_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 data/items/expires_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/restored_branches/items/deleted_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/schema_snapshot became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/schema_snapshot/linted_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/started_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
- ▲
  the response property data/items/backup_policy became optional for the status 200
  response-property-became-optional
- ▲
  the response property data/items/database_branch became optional for the status 200
  response-property-became-optional
- ▲
  the response property data/items/schema_snapshot became optional for the status 200
  response-property-became-optional
- ○
  added the required property data/items/backup_policy/display_name to the response with the 200 status
  response-required-property-added
- ○
  added the required property type to the response with the 200 status
  response-required-property-added
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
Dec 4, 20255e881928d77a211See the full diff
- ▲
  the data/items/backup_policy/schedule_day response's property type/format changed from string/ to number/ for status 200
  response-property-type-changed
- ▲
  the data/items/backup_policy/schedule_week response's property type/format changed from string/ to number/ for status 200
  response-property-type-changed
- ○
  removed the 0.00 enum value from the data/items/backup_policy/schedule_day response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 0.00 enum value from the data/items/backup_policy/schedule_week response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 1.00 enum value from the data/items/backup_policy/schedule_day response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 1.00 enum value from the data/items/backup_policy/schedule_week response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 2.00 enum value from the data/items/backup_policy/schedule_day response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 2.00 enum value from the data/items/backup_policy/schedule_week response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 3.00 enum value from the data/items/backup_policy/schedule_day response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 3.00 enum value from the data/items/backup_policy/schedule_week response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 4.00 enum value from the data/items/backup_policy/schedule_day response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 5.00 enum value from the data/items/backup_policy/schedule_day response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the 6.00 enum value from the data/items/backup_policy/schedule_day response property for the response status 200
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history