v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Pipeline Execution

Pipeline Execution Details

Returns the full details of a pipeline execution, including its current status, trigger, timings, and result message. If you only need to poll for status changes, consider using the lightweight getExecutionStatusOnly endpoint instead.

get/v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId}

Path parameters

projectIdstring required

pipelineExecutionIdstring uuid required

Response

Pipeline execution details have been retrieved

environmentNamestring

The name of the environment the pipeline was executed in

finishedAtstring date-time

The time the pipeline execution finished

messagestring

The message returned by the pipeline execution

pipelineExecutionIdstring

The ID of the pipeline execution

pipelineNamestring

The name of the pipeline executed

pipelineTypestring

The type of pipeline executed

projectIdstring

The id of the project the pipeline was executed in

scheduleIdstring

The id of the schedule that triggered the pipeline execution if trigger is SCHEDULE

startedAtstring date-time

The time the pipeline execution started

statusstring

Status of executed pipeline

trigger'DESIGNER' | 'API' | 'SCHEDULE' | 'SCHEDULE_RUN_NOW' | 'UNKNOWN'

The trigger of the pipeline execution

userstring

The user that triggered the pipeline execution. Present when trigger is DESIGNER or SCHEDULE_RUN_NOW

Example response

{
  "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"
}