WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« suggest tasks.get »

› ›

tasks.cancel

edit

tasks.cancel

edit

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

Reference

`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_node` or `parentNode`	`string` - Cancel tasks with specified parent node.
`parent_task_id` or `parentTaskId`	`string` - Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.

« suggest tasks.get »