Update a backup job

Changes the schedule days, retention, name, enabled state or VMs of a backup job. Only the fields you send are changed. Each VM can be in one job only.

Authorization

bearerAuth

AuthorizationBearer <token>

API key created in the portal (Settings → API Keys). Send as Authorization: Bearer <key>.

In: header

Path Parameters

cloud_job_uuid*string

Backup job UUID (uuid from the backup job list).

uuid*string

Project UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Fields to change on a backup job. Omitted fields stay as they are.

weekdays?array<>

Days of the week the job runs. At least one.

Items1 <= items

retention?

Retention policy. Replaces the current one; periods left out or set to 0 are not kept. Empty or all zeros keeps every backup.

comment?string

Job name. Empty resets it to {project name} backup.

Lengthlength <= 512

vmids?array<>

VMIDs backed up by this job. Replaces the current list; each VM can be in one job only.

enabled?boolean

Whether the job runs on schedule.

Response Body

`application/json`

curl -X PATCH "https://example.com/cloud/project/string/cluster/backup-jobs/manage/string/" \  -H "Content-Type: application/json" \  -d '{}'

{  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",  "comment": "string",  "enabled": true,  "weekdays": [    "mon"  ],  "schedule_slot": "string",  "retention": {    "keep_last": 0,    "keep_hourly": 0,    "keep_daily": 0,    "keep_weekly": 0,    "keep_monthly": 0,    "keep_yearly": 0  },  "vmids": [    0  ]}