createBackup

POST

/api/v1/system/backups

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

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

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

Start a system backup. Requires an Owner with the admin scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Responses

202

Backup job started

application/json

object

data

required

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

Example

{
  "data": {
    "kind": "backup"
  }
}

401

Dashboard authentication required

403

Insufficient role

409

Backup already in progress