NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

tasks.cancel

client.tasks.cancel({
  task_id: string,
  nodes: string | string[],
  actions: string | string[],
  parent_task_id: string
})

`task_id` or `taskId`	`string` - Cancel the task with specified task id (node_id:task_number)
`nodes`	`string \| string[]` - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you’re connecting to, leave empty to get information from all nodes
`actions`	`string \| string[]` - A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
`parent_task_id` or `parentTaskId`	`string` - Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.