Create a Backup Job

POST

/cluster/backups/jobs

curl --request POST \
  --url https://sylve.lan:8181/api/cluster/backups/jobs \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "cronExpr": "example", "enabled": true, "encrypted": true, "jailRootDataset": "example", "mode": "example", "name": "example", "pruneKeepLast": 1, "pruneTarget": true, "recursive": true, "runnerNodeId": "example", "sourceDataset": "example", "stopBeforeBackup": true, "targetId": 1 }'

Create a scheduled backup job

Authorizations

• BearerAuth

Request Body

Backup Job Request

Media typeapplication/json

object

cronExpr

string

enabled

boolean

encrypted

boolean

jailRootDataset

string

mode

required

string

name

required

string

>= 2 characters

pruneKeepLast

integer

pruneTarget

boolean

recursive

boolean

runnerNodeId

string

sourceDataset

string

stopBeforeBackup

boolean

targetId

required

integer

Example^generated

{
  "cronExpr": "example",
  "enabled": true,
  "encrypted": true,
  "jailRootDataset": "example",
  "mode": "example",
  "name": "example",
  "pruneKeepLast": 1,
  "pruneTarget": true,
  "recursive": true,
  "runnerNodeId": "example",
  "sourceDataset": "example",
  "stopBeforeBackup": true,
  "targetId": 1
}

Responses

201

Created

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Backup Target Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request Entity Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}