Addons /

List addon backups

Returns a list of backups for the given addon.

Required permission

Project > Addons > General > Read

Path parameters

projectId
string required
ID of the project
addonId
string required
ID of the addon

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

backups
[array] required
A list of backups for the given addon.

{object}
Data about a backup.

id
string required
The identifier for the backup.
name
string required
The name of the backup.
status
string required
The current status of the backup.
one of
scheduled, in-progress, completed, aborting, aborted, failed, not-supported
createdAt
string required
The time the backup was initiated.
completedAt
string required
The time the backup was completed.
config
{object} required
Data about the backup configuration.

source
{object}
Data about the source of the backup.

type
string
The type of backup.
one of
fileUpload, liveInstance, snapshot, externalDump, sameAddon

size
string required
The size of the backup, in bytes
compressionType
string
The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`.
one of
gz, zstd
additionalDestinations
[array]
List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups.

{object}

destinationId
string required
Additional custom back up destination that should be used to store the snapshot.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$
retentionTime
integer
Retention time of the additional back up in days.
min
1
max
120
type
string required
The type of backup destination to use
one of
custom

addonVersion
string
The version of the addon at the time of the backup. If the backup type is `snapshot`, the addon will be restored to this version when the backup is restored.

customDestinationId
string
Custom backup destination in which the dump back up should be stored.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

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.

API

CLI

JS Client

GET /v1/projects/{projectId}/addons/{addonId}/backups

Example response

200 OK

A list of backups for the addon.

JSON

{
  "data": {
    "backups": [
      {
        "id": "example-backup",
        "name": "Example Backup",
        "status": "completed",
        "createdAt": "2021-01-20T11:19:53.175Z",
        "completedAt": "2021-01-20T11:19:54.494Z",
        "config": {
          "source": {
            "type": "snapshot"
          },
          "size": "1234",
          "compressionType": "gz",
          "additionalDestinations": [
            {
              "destinationId": "example-backup-destination",
              "type": "custom"
            }
          ],
          "addonVersion": "4.4.8"
        },
        "customDestinationId": "example-backup-destination"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}