Skip to content
SYLVE

Modify retention of a periodic ZFS snapshot job

PATCH
/zfs/datasets/snapshot/periodic/{id}
curl --request PATCH \
  --url https://sylve.lan:8181/api/zfs/datasets/snapshot/periodic/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "cronExpr": "example", "interval": 1, "keepDaily": 1, "keepHourly": 1, "keepLast": 1, "keepMonthly": 1, "keepWeekly": 1, "keepYearly": 1, "maxAgeDays": 1, "retentionType": "example" }'

Modify retention of a periodic ZFS snapshot job

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer
>= 1

Periodic snapshot job ID

Request Body

Section titled “Request Body”

Modify Periodic Snapshot Retention Request

Media typeapplication/json
object
cronExpr
string
interval
integer
keepDaily
integer
keepHourly
integer
keepLast
integer
keepMonthly
integer
keepWeekly
integer
keepYearly
integer
maxAgeDays
integer
retentionType
string
Examplegenerated
{
  "cronExpr": "example",
  "interval": 1,
  "keepDaily": 1,
  "keepHourly": 1,
  "keepLast": 1,
  "keepMonthly": 1,
  "keepWeekly": 1,
  "keepYearly": 1,
  "maxAgeDays": 1,
  "retentionType": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}