GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
backups
List backups
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/backups \
  --header 'Authorization: <api-key>'
{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organization
string
required

The name of the organization the branch belongs to

​
database
string
required

The name of the database the branch belongs to

​
branch
string
required

The name of the branch

Query Parameters

​
all
boolean

Whether to include all backups, including deleted ones

​
state
enum<string>

Filter backups by state

Available options:
pending,
running,
success,
failed,
canceled,
ignored
​
policy
string

Filter backups by backup policy ID

​
from
string

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

​
to
string

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

​
running_at
string

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

​
production
boolean

Filter backups by production branch

​
page
number
default:1

If provided, specifies the page offset of returned results

​
per_page
number
default:25

If provided, specifies the number of returned results

Response

Returns database branch backups

​
current_page
number
required

The current page number

​
next_page
number
required

The next page number

​
next_page_url
string
required

The next page of results

​
prev_page
number
required

The previous page number

​
prev_page_url
string
required

The previous page of results

​
data
object[]
required