List team backups

Lists backups across projects for the required addon or volume resource type, newest first. Filters are combined; comma-separated values match any listed value. Includes retained backups of deleted addons. Each request returns one resource type; filters specific to the other type are rejected. Cursor pagination is recommended; use the returned ObjectId cursor rather than a backup ID or UUID.

Required permission

Account > Platform > Backups > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
min
1
max
100
page
integer
The page number to access.
min
1
cursor
string
The cursor returned from the previous page of results, used to request the next page.
min length
24
max length
24
resourceType
string
Return addon backups or volume backups. Exactly one resource type is required.
one of
addon, volume
volumeId
string
Volume ID or comma-separated volume IDs, matched across the selected projects.
max length
10100
projectId
string
Project ID or comma-separated project IDs. Matches addon backup metadata or existing project records for volumes, including soft-deleted projects and reused IDs.
max length
10100
addonId
string
Addon ID or comma-separated addon IDs. Matches stored IDs across selected projects, or the whole team when projectId is omitted, including IDs reused after deletion.
max length
10100
addonType
string
Filter by addon type.
max length
100
backupType
string
Backup type or comma-separated backup types: sameAddon, snapshot, global, externalDump, fileUpload, liveInstance.
max length
10100
status
(multiple options: oneOf)
Status or comma-separated statuses. Addons: scheduled, in-progress, completed, aborting, aborted, failed, not-supported. Volumes: DELETED, PENDING, IN_PROGRESS, FAILED, READY. Deleted backups are excluded.

string required

max length

10100

customDestinationId
string
Filter by primary custom destination ID. Only current destinations are resolved.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$
after
string
Include backups created at or after this ISO-8601 timestamp.
before
string
Include backups created at or before this ISO-8601 timestamp.
search
string
Case-insensitive literal substring of the backup name or ID.
max length
100

Response body

{object}
Response object.

data
{object} required
Result data.

backups
[array] required
Backups of the selected resource type, newest first.

(multiple options: oneOf)

{object}

resourceType
string required
one of
addon
id
string required
The backup ID.
uid
string
The backup UUID, when available.
name
string required
The backup name.
status
string required
one of
scheduled, in-progress, completed, aborting, aborted, failed, not-supported
createdAt
string required
completedAt
string
project
{object}
Project metadata recorded with the backup.

id
string required
Stored resource ID.
name
string required
Stored resource name.

addon
{object}
Addon metadata recorded with the backup.

id
string required
Stored resource ID.
name
string required
Stored resource name.

customDestinationId
string
Primary custom destination ID, when its public ID is available.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$
config
{object} required

source
{object}
Backup source type, when recorded on the backup.

type
string required
one of
sameAddon, snapshot, global, externalDump, fileUpload, liveInstance

addonType
string
addonVersion
string
size
string
Final backup size in bytes, when available.
compressionType
string
one of
zstd, gz, none
additionalDestinations
[array]

(multiple options: anyOf)

{object}

type
string required
one of
custom
destinationId
string required
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$
retentionTime
integer
The time the backup is retained for, in days.
min
1

{object}

type
string required
one of
default

{object}

id
string required
Identifier for the backup
uid
string
Stable identifier for using this backup as a volume source
name
string required
description
string
spec
{object}
source
{object}

type
string
sourceObject
{object}

id
string required
spec
{object}

createdAt
string
time of creation
updatedAt
string
time of update
resourceType
string required
one of
volume
status
string required
one of
DELETED, PENDING, IN_PROGRESS, FAILED, READY
project
{object}
Project metadata, when the project still exists.

id
string required
Stored resource ID.
name
string required
Stored resource name.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

GET /v1/backups

GET /v1/teams/{teamId}/backups

Example response

200 OK

A list of backups belonging to the team.

JSON

{
  "data": {
    "backups": [
      {
        "config": {
          "additionalDestinations": [
            {
              "retentionTime": 7
            }
          ]
        }
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}