Get a pipeline run
Returns a pipeline run, with the state of each of its stages.
/project/{project_id}/environment/{environment_id}/pipeline-runs/{pipeline_run_id}AuthorizationBearer token (JWT) · headerrequiredJWT token passed in the Authorization header using the Bearer <token> format.
project_iduuidrequiredThe unique identifier for the project
environment_iduuidrequiredThe unique identifier of the environment
pipeline_run_iduuidrequiredThe unique identifier for the pipeline run
Pipeline run retrieved successfully
iduuidrequiredA universally unique identifier (UUID) string
organization_iduuidrequiredA universally unique identifier (UUID) string
project_iduuidrequiredA universally unique identifier (UUID) string
environment_iduuidrequiredA universally unique identifier (UUID) string
pipeline_iduuidrequiredA universally unique identifier (UUID) string
statuscomponent_deployment_staterequiredDeployment state for a component resource.
QUEUEDSCHEDULEDRUNNINGRETRYINGSUCCEEDEDFAILEDCANCELEDTIMED_OUTSKIPPEDNONEtriggered_by_user_iduuid | nullShow propertiesHide properties
string<uuid>nullworkflow_idstring | nullworkflow_run_iduuid | nullShow propertiesHide properties
string<uuid>nullstarted_atstring<date-time> | nullfinished_atstring<date-time> | nullmessagestring | nullstage_runspipeline_run_stage[]requiredShow propertiesHide properties
pipeline_run_stageiduuidrequiredA universally unique identifier (UUID) string
stage_iduuidrequiredA universally unique identifier (UUID) string
namestring | nulldescriptionstringexecution_orderintegerrequiredon_failurepipeline_stage_failure_policyrequiredDescribes how the pipeline should behave after a stage failure.
STOP_PIPELINECONTINUE_PIPELINEstatuscomponent_deployment_staterequiredDeployment state for a component resource.
QUEUEDSCHEDULEDRUNNINGRETRYINGSUCCEEDEDFAILEDCANCELEDTIMED_OUTSKIPPEDNONEstarted_atstring<date-time> | nullfinished_atstring<date-time> | nullmessagestring | nullcomponent_runscomponent_run[]requiredShow propertiesHide properties
component_runiduuidrequiredA universally unique identifier (UUID) string
organization_iduuidrequiredA universally unique identifier (UUID) string
project_iduuidrequiredA universally unique identifier (UUID) string
environment_iduuidrequiredA universally unique identifier (UUID) string
component_iduuidrequiredA universally unique identifier (UUID) string
component_kindcomponent_kindrequiredComponent kind for component-scoped variables
KjobKApplicationKHelmKDatabasecomponent_namestringrequiredcomponent_sidstringrequiredactionstringrequireddeploytriggerstringrequiredmanualpushpipelinestatuscomponent_deployment_staterequiredDeployment state for a component resource.
QUEUEDSCHEDULEDRUNNINGRETRYINGSUCCEEDEDFAILEDCANCELEDTIMED_OUTSKIPPEDNONEpipeline_contextcomponent_run_pipeline_context | nullShow propertiesHide properties
pipeline_iduuidrequiredA universally unique identifier (UUID) string
pipeline_run_iduuidrequiredA universally unique identifier (UUID) string
stage_run_iduuidrequiredA universally unique identifier (UUID) string
pipeline_component_run_iduuidrequiredA universally unique identifier (UUID) string
stage_component_iduuidrequiredA universally unique identifier (UUID) string
requiredbooleanrequiredtimeout_secondsinteger | nullnullgithub_buildcomponent_run_github_build | nullShow propertiesHide properties
installation_iduuidrequiredA universally unique identifier (UUID) string
repository_idstringrequiredGitHub repository database ID encoded as a decimal string.
repository_full_namestringrequiredbranchstringrequiredcommit_shastringrequiredtriggerstringrequiredmanualpushpipelineimage_referencestring | nullFinal tagged OCI image reference when artifact production completed.
image_tagstring | nullFinal run-scoped OCI tag when artifact production completed.
index_digeststring | nullVerified final OCI image index digest when available.
platformsstring[]requirednullworkflow_idstring | nullworkflow_run_iduuid | nullShow propertiesHide properties
uuidnullstarted_atstring<date-time> | nullfinished_atstring<date-time> | nullmessagestring | nullcreated_atstring<date-time>requiredupdated_atstring<date-time>requiredcreated_atstring<date-time>requiredupdated_atstring<date-time>requiredError
codeinteger<int32>requiredmessagestringrequiredreasonstringOptional stable machine-readable reason for programmatic error handling