deleteBackup

DELETE

/api/v1/system/backups/{id}

const url = 'https://example.com/api/v1/system/backups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'DELETE'};

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

curl --request DELETE \
  --url https://example.com/api/v1/system/backups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Delete a system backup. The last complete backup is protected until confirmed again. Requires an Owner with the write scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Path Parameters

required

string format: uuid

Header Parameters

X-CSRF-Token

string

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

Query Parameters

force

boolean

Confirm again when deleting the last complete backup.

Responses

200

Backup deleted

application/json

object

data

required

object

deleted

required

boolean

Example

{
  "data": {
    "deleted": true
  }
}

401

Dashboard authentication required

403

Insufficient role

404

Backup not found

409

Job active or last complete backup

422

Archive incomplete