Skip to content

Launch a new pipeline

POST
/pipeline/launch

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.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Pipeline launch request.

object
id

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

string
Example
08446737-da9b-4787-8599-97d85c48c3bb
definition
required

The pipeline definition.

string
Example
export | where foo
name

The human-readable name of the pipeline.

string
default: [an auto-generated id]
Example
interactive-query
hidden

Whether this pipeline is hidden.

boolean
Example
true
ttl

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.

string
nullable
Example
5min
autostart

Flags that specify on which state to restart the pipeline.

object
created

Autostart the pipeline upon creation.

boolean
Example
true
completed

Autostart the pipeline upon completion.

boolean
failed

Autostart the pipeline upon failure.

boolean
autodelete

Flags that specify on which state to delete the pipeline.

object
completed

Autodelete the pipeline upon completion.

boolean
failed

Autodelete the pipeline upon failure.

boolean
Example
true
stopped

Autodelete the pipeline when it stops before completing.

boolean
retry_delay

The minimum time between automatic restarts after a pipeline error.

string
default: 1min
Example
500ms
unstoppable

Whether this pipeline is unstoppable.

boolean
cache_id

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

string
Example
4ada2434-32asfe2s
cache_capacity

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

integer
>= 1
Example
4000
cache_read_timeout

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

string
Example
1min
cache_write_timeout

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

string
Example
1h
serve_id

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

string
Example
4ada2434-32asfe2s
serve_buffer_size

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

integer
>= 1
Example
4000
Example
{
  "definition": "export | where foo",
  "name": "interactive-query",
  "serve_id": "query-1",
  "serve_buffer_size": 4000
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The launch request was accepted.

One of:
object
deployable

Returns this property with the value true.

boolean
Example
true

400

Section titled “400 ”

Invalid arguments or invalid pipeline.

object
error
required

The error message.

string
Example
Invalid arguments
diagnostics
Array<object>
object
severity
string
Allowed values: error warning note
message
string
Example
unknown option `--frobnify`
annotation
Array<object>
object
primary
boolean
text

A potentially empty label.

string
Example
this option does not exist
source

A region in the source code, defined by byte offsets.

object
begin
number
Example
42
end
number
Example
48
notes
Array<object>
object
kind
string
Allowed values: note usage hint docs
Example
usage
message
string
Example
file <path> [-f|--follow] [-m|--mmap] [-t|--timeout <duration>]
rendered
string
Example
error: unknown option `--frobnify`