Skip to content

List all existing pipelines

POST
/pipeline/list

Lists all existing pipelines.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success.

An array of all pipelines.

object
pipelines
Array<object>
object
id

The pipeline id.

string
name

The human-readable name of the pipeline.

string
definition

The pipeline definition.

string
unstoppable

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

boolean
Example
true
hidden

Whether this pipeline is hidden. Hidden pipelines are only available through the show pipelines operator.

bool
created_at

The Unix timestamp of the pipeline creation time in nanoseconds.

integer format: int64
last_modified

The Unix timestamp of the last pipeline modification in nanoseconds.

integer format: int64
start_time

If the pipeline has been started, the ISO 8601 timestamp of the most recent start.

string
total_runs

The total amount of runs this pipeline has attempted so far.

integer
state
string
Allowed values: created running paused failed stopped completed
error

The error that the pipeline may have encountered during running.

string
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`
labels

The user-provided labels for this pipeline.

Array<object>
object
text

The pipeline label text.

string
Example
zeek
color

The pipeline label color.

string
Example
3F1A24
retry_delay

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.

string
Example
10s
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
ttl

If a TTL exists for this pipeline, the TTL as a duration string.

string
Example
2min
remaining_ttl

If a TTL exists for this pipeline, the remaining TTL as a duration string.

string
Example
10s
Example
{
  "pipelines": [
    {
      "id": "4c7f2b11-6169-4d1b-89b4-4fc0a68b3d4a",
      "name": "user-assigned-name",
      "definition": "export | where foo | publish /bar",
      "hidden": false,
      "created_at": 1706180157837037600,
      "last_modifed": 1706180157837038000,
      "state": "running",
      "error": null,
      "diagnostics": []
    },
    {
      "id": "08446737-da9b-4787-8599-97d85c48c3bb",
      "name": "wrong-pipeline",
      "definition": "export asdf",
      "hidden": false,
      "created_at": 1706180157837037600,
      "last_modifed": 1706180157837038000,
      "state": "failed",
      "error": "format 'asdf' not found",
      "diagnostics": []
    }
  ]
}

400

Section titled “400 ”

Invalid arguments.

object
error
required

The error message.

string
Example
Invalid arguments