Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Pipeline Execution

Pipeline Executions

This returns a list of summarised pipeline executions.The list is ordered by the start time of the execution, with the most recent execution first. It can be paginated by providing a paginationToken query parameter obtained from a previous response.

get/v1/pipeline-executions

Query parameters

projectIdstring

Filter results to pipelines belonging to this project.

paginationTokenstring

Token to fetch the next batch of results for a previous query.

limitinteger

The maximum number of results to return (capped at 100).

pipelineNamestring

Search against pipeline name, with case-insensitive partial matching.

environmentNamestring

Filter results to pipelines executed within this environment.

startedAfterstring date-time

Filter results to pipelines started at or after this moment.

startedBeforestring date-time

Filter results to pipelines started at or before this moment.

timeFramestring

Filter results to pipelines that started within this time frame, relative to now. Accepts an ISO-8601 duration string in the PnDTnHnMnS format, using days, hours, minutes and/or seconds, e.g. P1D, P7D, PT1H, PT30M, PT90S. Week, month and year units (P1W, P1M, P1Y) are not supported — use the day-based equivalents P7D, P30D and P365D instead.

status'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLING' | 'CANCELLED' | 'FORBIDDEN' | 'SKIPPED' | 'UNKNOWN'

Filter results to pipelines which have the status of one of the provided values.

scheduleIdstring

Filter results to pipelines belonging to this schedule.

Response

Pipelines executions returned successfully

morestring

Token for fetching the next batch of results for this query; if omitted then there are no more.

Example response

{
  "results": [
    {
      "environmentName": "Dev",
      "message": "\"Rewrite Table\": Success",
      "pipelineExecutionId": "fd05a6c4-b3e1-4441-86a2-044d5092731d",
      "pipelineName": "My Pipeline",
      "pipelineType": "ORCHESTRATION",
      "projectId": "4a8a6162-702b-4efc-b2ec-c986e0bc95e4",
      "scheduleId": "9e2a6b04-ddd7-4bb4-b7dc-56e3b6f3ed43",
      "status": "RUNNING",
      "trigger": "SCHEDULE",
      "user": "A User"
    }
  ]
}