tasks

Update an existing task

Changed on
patch/tasks/{id}

Request

  • Base URL
    /kapacitor/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Path parameters

idstring required

Request body

idstring

Task ID

typestring

Task type, one of 'stream' or 'batch'

scriptstring

TICKscript content

statusstring

Enabled/Disabled status of the task

dotstring

Graphviz DOT syntax representation of the task DAG

executingboolean

Whether the task is currently executing

errorunknown
createdstring dateTime

Date task was first created

modifiedstring dateTime

Date task was last modified

last-enabledstring dateTime

Date task was last enabled

template-idstring

Template ID

varsobject

Set of vars to overwrite any TICKscript vars.

Response

Update succeeded

idstring

Task ID

typestring

Task type, one of 'stream' or 'batch'

scriptstring

TICKscript content

statusstring

Enabled/Disabled status of the task

dotstring

Graphviz DOT syntax representation of the task DAG

executingboolean

Whether the task is currently executing

errorunknown
createdstring dateTime

Date task was first created

modifiedstring dateTime

Date task was last modified

last-enabledstring dateTime

Date task was last enabled

template-idstring

Template ID

varsobject

Set of vars to overwrite any TICKscript vars.

Changes

    • breaking

      removed the success response with the status

    • info

      added the success response with the status

    • breaking

      removed the success response with the status

    • info

      added the success response with the status