pool.snapshottask.delete

Delete a Periodic Snapshot Task with specific id

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the periodic snapshot task to delete.
Parameter 2: options

options

Type: object

Options for controlling task deletion behavior.

 No Additional Properties

Fixate Removal Date

Type: boolean Default: false

Whether to fix the removal date of existing snapshots when the task is deleted.

Result

Type: const

Indicates successful deletion of the periodic snapshot task.

Must be one of:
  • true
Specific value: true


Required roles: SNAPSHOT_TASK_WRITE