TEtenzir
Pipelines

Launch a new pipeline

Creates a pipeline and prepares it for interactive use. If the pipeline does not end with a sink, Tenzir adds an implicit output stream and returns the created pipeline ID. If the pipeline already has a sink, Tenzir returns deployable: true so the caller can deploy it explicitly.

post/pipeline/launch

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.

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 finite and defined if the hidden parameter is true.

retry_delaystring

The minimum time between automatic restarts after a pipeline error.

unstoppableboolean

Whether this pipeline is unstoppable.

cache_idstring

The identifier for the cache operator, which is inserted only when this parameter is provided.

cache_capacityinteger

The maximum number of events to keep in the cache operator.

cache_read_timeoutstring

The time to live of the cache. Resets when reading from the cache.

cache_write_timeoutstring

The maximum time to live of the cache. Unlike the cache_read_timeout parameter, this does not reset when reading from the cache.

serve_idstring

The output stream identifier to create for reading events from this pipeline.

serve_buffer_sizeinteger

The maximum number of events to buffer for the output stream.

Example request

{
  "id": "08446737-da9b-4787-8599-97d85c48c3bb",
  "definition": "export | where foo",
  "name": "interactive-query",
  "hidden": true,
  "ttl": "5min",
  "autostart": {
    "created": true
  },
  "autodelete": {
    "failed": true
  },
  "retry_delay": "500ms",
  "cache_id": "4ada2434-32asfe2s",
  "cache_capacity": 4000,
  "cache_read_timeout": "1min",
  "cache_write_timeout": "1h",
  "serve_id": "4ada2434-32asfe2s",
  "serve_buffer_size": 4000
}

Response

The launch request was accepted.

OR

Example response

{
  "deployable": true
}

Changes

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