v1

latestOpenAPI 3.1.02026-07-263992128.7 KB
Pipelines

List pipelines

List pipelines for the workspace linked to the API key.

Always pass page and page_size to receive a paginated response with page, page_size, total, and results fields, sorted by pipeline name. Use name to filter pipelines by a case-insensitive substring match on the pipeline name.

get/pipelines

Query parameters

pageinteger nullable

Page number. Must be greater than or equal to 1.

page_sizeinteger nullable

Number of items per page. Defaults to 50; maximum 100.

namestring nullable

Filter by a case-insensitive substring match on the pipeline name.

Response

Successful response.

idstring uuid4 required
namestring required
numTasksinteger nullable
yamlPathstring required
createdAtstring required
updatedAtstring required
pausedboolean required
triggerEventsstring nullable
webhookstring nullable
schedulestring nullable
sensorsstring nullable
inputsobject nullable
productIdstring uuid4 nullable
productNamestring nullable
latestVersionNumberinteger nullable
publishedVersionNumberinteger nullable
storageProviderstring nullable
repositorystring nullable
defaultBranchstring nullable
aliasstring nullable
latestRunIdstring uuid4 nullable
latestRunStatus'CREATED' | 'RUNNING' | 'SUCCEEDED' | 'WARNING' | 'FAILED' | 'SKIPPED' | 'CANCELLING' | 'CANCELLED'
latestRunMessagestring nullable
latestRunCreatedAtstring nullable
latestRunCompletedAtstring nullable
latestRunStartedAtstring nullable