TEtenzir
Pipelines

Update pipeline state

Updates the definition, metadata, or lifecycle state of a pipeline. Tenzir leaves omitted fields unchanged.

post/pipeline/update

Request

Request body

idstring required

The id of the pipeline to be updated.

definitionstring

The updated definition of the pipeline.

action'start' | 'pause' | 'stop' | 'force-stop'

The action that will change the pipeline's running state.

namestring

Update the human-readable name of the pipeline to this value.

retry_delaystring

A duration string specifying the minimum time between automatic restarts of a pipeline when an error occurs. Takes no effect if restarting on failure is disabled.

unstoppableboolean

A flag specifying whether this pipeline is unstoppable. Unstoppable pipelines start automatically, fail when they complete, and can not be paused or stopped manually.

Example request

{
  "id": "08446737-da9b-4787-8599-97d85c48c3bb",
  "definition": "export | where baz | publish /foo",
  "action": "start",
  "name": "zeek-monitoring-pipeline",
  "labels": [
    {
      "text": "zeek",
      "color": "3F1A24"
    }
  ],
  "autostart": {
    "created": true
  },
  "autodelete": {
    "failed": true
  },
  "retry_delay": "500ms",
  "unstoppable": true
}

Response

The pipeline was updated.

Example response

{
  "pipeline": {
    "unstoppable": true,
    "diagnostics": [
      {
        "message": "unknown option `--frobnify`",
        "annotation": [
          {
            "text": "this option does not exist",
            "source": {
              "begin": 42,
              "end": 48
            }
          }
        ],
        "notes": [
          {
            "kind": "usage",
            "message": "file <path> [-f|--follow] [-m|--mmap] [-t|--timeout <duration>]"
          }
        ],
        "rendered": "\u001b[1m\u001b[31merror\u001b[39m: unknown option `--frobnify`\u001b[0m\n"
      }
    ],
    "labels": [
      {
        "text": "zeek",
        "color": "3F1A24"
      }
    ],
    "retry_delay": "10s",
    "autostart": {
      "created": true
    },
    "autodelete": {
      "failed": true
    },
    "ttl": "2min",
    "remaining_ttl": "10s"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.