Skip to content

Edit Pool

PATCH
/zfs/pools/{guid}
curl --request PATCH \
--url https://sylve.lan:8181/api/zfs/pools/example \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "properties": { "additionalProperty": "example" }, "spares": [ "example" ] }'

Edit a ZFS pool’s properties

guid
required
string

Pool GUID

Request

Media typeapplication/json
object
properties
object
key
additional properties
string
spares
Array<string>
Examplegenerated
{
"properties": {
"additionalProperty": "example"
},
"spares": [
"example"
]
}

Success

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

Bad Request

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

Not Found

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

Internal Server Error

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