Skip to main content
Return a page of pipelines in the project, with their versions and pagination metadata. The listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.

Signature

Method signatures on client.pipelines:

Parameters

listAll()

string
required
Project ID with prefix pp..
number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.

listPage()

string
required
Project ID with prefix pp..
number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.

Returns

listAll() result

AsyncGenerator<Pipeline> Yields one item at a time. The fields below describe each yielded item. A pipeline within a project.
PipelineId
required
Pipeline ID with prefix pl..
ProjectId
required
Project ID with prefix pp..
string
required
Name of the pipeline.
number
required
Pipeline version number; copying a pipeline increments the source version.
string
required
Time the pipeline was created, as an ISO 8601 timestamp.
string
required
Time the pipeline was last updated, as an ISO 8601 timestamp.

listPage() result

Promise<{ pipelines: Pipeline[]; pagination: Pagination }>
Pipeline[]
required
Pipelines in this page.
Pagination
required
Pagination information for this page.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: GET /projects/{projectId}/pipelines.