v17

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

Backups

List backups

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

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

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

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

Returns database branch backups

typestring required

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

current_pageinteger required

The current page number

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