pool.snapshot.delete

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

ID of the snapshot to delete.
Parameter 2: options

options

Type: object

Options for controlling snapshot deletion behavior.

 No Additional Properties

Defer

Type: boolean Default: false

Defer deletion of the snapshot.

Recursive

Type: boolean Default: false

Whether to recursively delete child snapshots.

Result

Type: const

Indicates successful snapshot deletion.

Must be one of:
  • true
Specific value: true


Required roles: SNAPSHOT_DELETE