pool.snapshot.update

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

ID of the snapshot to update.
Parameter 2: data

data

Type: object

The property updates to apply to the snapshot.

 No Additional Properties

User Properties Update

Type: array of object Default: []

Properties to update.

 No Additional Items
Each item of this array must be:

PoolSnapshotUserPropertyUpdate

Type: object
No Additional Properties

Key

Type: string

The property name in namespace:property format.

Must match regular expression: .*:.*

Value

Type: string

The new value to assign to the user property.

Must be at most 2147483647 characters long

User Properties Remove

Type: array of string Default: []

Properties to remove.

 No Additional Items
Each item of this array must be:
Type: string

ZFS user property key in namespace:property format (e.g., 'custom:backuppolicy', 'org:createdby').

Must match regular expression: .*:.*

Type: object

Information about the updated snapshot.


Required roles: SNAPSHOT_WRITE