# pool.snapshot.hold

Hold snapshot id.

Add truenas tag to the snapshot’s tag namespace.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: id

#### id

Type: string

ID of the snapshot to hold.

##### Parameter 2: options

#### options

Type: object

Options for controlling snapshot hold behavior.

No Additional Properties

##

#### Recursive

Type: boolean Default: false

Hold snapshots recursively.

##

#### Result

Type: null

Returns `null` on successful snapshot hold.

Required roles: SNAPSHOT_WRITE