Update a ZFS scrub schedule

PUT

/zfs/pools/scrub/schedules/{id}

curl --request PUT \
  --url https://sylve.lan:8181/api/zfs/pools/scrub/schedules/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "cronExpr": "example", "enabled": true, "poolGuid": "example" }'

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

integer

Schedule ID

Request Body

Schedule

Media typeapplication/json

object

cronExpr

required

string

enabled

boolean

poolGuid

required

string

Example^generated

{
  "cronExpr": "example",
  "enabled": true,
  "poolGuid": "example"
}

Responses

200

OK

Media typeapplication/json

object

data

object

active

boolean

createdAt

string

cronExpr

string

enabled

boolean

id

integer

lastError

string

lastRunAt

string

lastStatus

string

nextRunAt

string

poolGuid

string

poolName

string

progressKnown

boolean

progressPct

integer

queuedAt

string

updatedAt

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "active": true,
    "createdAt": "example",
    "cronExpr": "example",
    "enabled": true,
    "id": 1,
    "lastError": "example",
    "lastRunAt": "example",
    "lastStatus": "example",
    "nextRunAt": "example",
    "poolGuid": "example",
    "poolName": "example",
    "progressKnown": true,
    "progressPct": 1,
    "queuedAt": "example",
    "updatedAt": "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"
}

404

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