zfs.resource.snapshot.release

Release hold(s) from a ZFS snapshot.

Invalid input is returned to the client as a JSON-RPC error response (code -32602, Invalid params); each failing condition appears in the error’s data.extra array with its own errno. A validation error is raised when:

• the snapshot does not exist

• the hold cannot be released

Examples:

Release a specific hold:

{"path": "tank/data@backup", "tag": "replication"}

Release all holds from a snapshot:

{"path": "tank/data@backup"}

Release a hold from matching snapshots in child datasets:

{"path": "tank@backup", "tag": "backup", "recursive": true}

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Release parameters for releasing holds on ZFS snapshots.

No Additional Properties

path Required

Path

Type: string

Snapshot path to release holds from (e.g., 'pool/dataset@snapshot').

Must be at least 1 characters long

tag

Tag

Default: null

Specific tag to release. If None, releases all hold tags.

Any of

• Option 1
• Option 2

Type: string

Type: null

recursive

Recursive

Type: boolean Default: false

Release holds recursively from matching snapshots in child datasets.

Return value

Result

Type: null

Required roles: SNAPSHOT_WRITE