INinfluxdata
tasks

Get an existing task

Changed on
get/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

Query parameters

dot-viewstring required

One of labels or attributes. Labels is less readable but will correctly render with all the information contained in labels.

script-formatstring required

One of formatted or raw. Raw will return the script identical to how it was defined. Formatted will first format the script.

replay-idstring

Optional ID of a running replay. The returned task information will be in the context of the task for the running replay.

Response

Task information

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