Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
Pipelines

List all Pipelines within an Organization. This can be filtered by Application.

get/orgs/{orgId}/pipelines

Path parameters

orgIdstring required

The Organization ID

Query parameters

appstring[]

An optional list of Application IDs.

[
  "sample-app"
]
per_pageinteger

The maximum number of items to return in a page of results

pagestring

The page token to request from

triggerstring

An optional filter by trigger type.

metadataobject

Optional filter by pipeline metadata

Response

Successful list response. If the Link header is present, more data may be available.

idstring required

The id of the Pipeline.

etagstring required

The current entity tag value for this Pipeline.

org_idstring required

The id of the Organization containing this Pipeline.

app_idstring required

The id of the Application containing this Pipeline.

namestring required

The name of the Pipeline.

statusstring required

The current status of the Pipeline.

versionstring required

The unique id of the current Pipeline Version.

created_atstring date-time required

The date and time when the Pipeline was created.

trigger_typesstring[] required

The list of trigger types in the current schema.

metadataobject

The map of key value pipeline additional information

Example response

[
  {
    "id": "sample-pipeline",
    "etag": "1234567890abcdef",
    "org_id": "sample-org",
    "app_id": "sample-app",
    "name": "Sample Pipeline",
    "status": "active",
    "version": "01234567-89ab-cdef-0123-456789abcdef",
    "created_at": "2023-01-01T00:00:00Z",
    "trigger_types": [
      "pipeline_call"
    ]
  }
]