Create a backup job

Creates a scheduled backup job for the listed VMs. The start time is assigned automatically between 00:00 and 06:00 (Europe/Warsaw). Each VM can be in one job only, and the number of jobs per project is limited.

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

uuid*string

Project UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Backup job to create.

weekdays*array<>

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

Items1 <= items

retention?

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

comment?string

Job name. Defaults to {project name} backup.

Lengthlength <= 512

Default""

vmids*array<>

VMIDs to back up. Each VM can be in one job only.

Items1 <= items

enabled?boolean

Whether the job runs on schedule.

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/cloud/project/string/cluster/backup-jobs/" \  -H "Content-Type: application/json" \  -d '{    "weekdays": [      "mon"    ],    "vmids": [      1    ]  }'

{  "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  ]}