listBackups

GET

/api/v1/system/backups

const url = 'https://example.com/api/v1/system/backups';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/system/backups

List system backups. Requires an Owner with the admin scope.

Responses

200

System backups

application/json

object

data

required

object

backups

required

Array<object>

object

required

string format: uuid

fileName

required

string

kind

required

string

status

required

string

sizeBytes

required

integer

archiveSha256

required

string

tilecastVersion

required

string

schemaVersion

required

integer

>= 1

installationId

required

string

organizationName

required

string

components

required

Array<object>

object

name

required

string

fileCount

required

integer

totalBytes

required

integer

verification

required

string

verifiedAt

string format: date-time

createdAt

required

string format: date-time

currentJob

required

One of:

object
null

object

required

string format: uuid

kind

required

string

Allowed values: backup verify restore

trigger

required

string

archiveId

string format: uuid

status

required

string

phase

required

string

progressPercent

required

integer

<= 100

errorCode

string

errorMessage

string

createdAt

required

string format: date-time

completedAt

string format: date-time

recentJobs

required

Array<object>

object

required

string format: uuid

kind

required

string

Allowed values: backup verify restore

trigger

required

string

archiveId

string format: uuid

status

required

string

phase

required

string

progressPercent

required

integer

<= 100

errorCode

string

errorMessage

string

createdAt

required

string format: date-time

completedAt

string format: date-time

lastSuccessful

required

One of:

object
null

object

required

string format: uuid

fileName

required

string

kind

required

string

status

required

string

sizeBytes

required

integer

archiveSha256

required

string

tilecastVersion

required

string

schemaVersion

required

integer

>= 1

installationId

required

string

organizationName

required

string

components

required

Array<object>

object

name

required

string

fileCount

required

integer

totalBytes

required

integer

verification

required

string

verifiedAt

string format: date-time

createdAt

required

string format: date-time

schedule

required

object

lastRunAt

string format: date-time

nextRunAt

string format: date-time

Example

{
  "data": {
    "currentJob": {
      "kind": "backup"
    },
    "recentJobs": [
      {
        "kind": "backup"
      }
    ]
  }
}

401

Dashboard authentication required

403

Insufficient role