List pipelines

POST

/pipeline/list

const url = 'https://example.com/api/v0/pipeline/list';
const options = {method: 'POST', headers: {'X-Tenzir-Token': '<X-Tenzir-Token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v0/pipeline/list \
  --header 'X-Tenzir-Token: <X-Tenzir-Token>'

Lists all visible pipelines.

Authorizations

TenzirToken

Responses

200

The pipeline list.

application/json

An array of all pipelines.

object

pipelines

Array<object>

object

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

hidden

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

boolean

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

nullable

diagnostics

Array<object>

object

severity

string

Allowed values: error warning note

message

string

annotation

Array<object>

object

primary

boolean

text

A potentially empty label.

string

source

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

object

begin

number

end

number

notes

Array<object>

object

kind

string

Allowed values: note usage hint docs

message

string

rendered

string

labels

The user-provided labels for this pipeline.

Array<object>

object

text

The pipeline label text.

string

color

The pipeline label color.

string

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

autostart

Flags that specify on which state to restart the pipeline.

object

created

Autostart the pipeline upon creation.

boolean

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

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

nullable

remaining_ttl

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

string

nullable

Example

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

400

Invalid arguments.

application/json

object

error

required

The error message.

string

Example

{
  "error": "Invalid arguments"
}