TEtenzir
Pipelines

Create a new pipeline

Creates a pipeline.

If autostart.created is true, Tenzir sends the response after the pipeline starts successfully. If startup fails, Tenzir discards the pipeline and returns the observed diagnostics.

post/pipeline/create

Request

Request body

idstring

The pipeline ID. If omitted, Tenzir generates a random ID.

definitionstring required

The pipeline definition.

namestring

The human-readable name of the pipeline.

hiddenboolean

Whether this pipeline is hidden. Hidden pipelines start automatically, are not persisted, and are omitted from the /pipeline/list response.

ttlstring nullable

A duration string specifying the maximum time for this pipeline to exist. No value means the pipeline is allowed to exist forever. This parameter must be defined if the hidden parameter is true.

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

Whether this pipeline is unstoppable. Unstoppable pipelines start automatically, fail when they complete, and can't be paused or stopped manually.

Example request

{
  "id": "08446737-da9b-4787-8599-97d85c48c3bb",
  "definition": "export | where foo | publish /bar",
  "name": "zeek-monitoring-pipeline",
  "ttl": "5min",
  "autostart": {
    "created": true
  },
  "autodelete": {
    "failed": true
  },
  "retry_delay": "500ms",
  "unstoppable": true
}

Response

The pipeline was created.

idstring required

The id of the successfully created pipeline.

Example response

{
  "id": "4c7f2b11-6169-4d1b-89b4-4fc0a68b3d4a"
}

Changes

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