Logo

Pipeline Runs

APIs to manage Pipeline Runs. Pipeline run status descriptions

  • PENDING - Pipeline run created.
  • QUEUED - Pipeline run queued for processing.
  • PROCESSING - Pipeline run received by scheduler for processing. (Processing a pipeline involves performing the operations required before starting a pipeline)
  • RUNNING - Pipeline run has started running.
  • WAITING - Pipeline run is waiting for an action (manual/automatic).
  • COMPLETE - The pipeline run has completed processing i.e. All stage runs are processed. A complete pipeline run can move to success or failure.
  • SUCCESS - A completed pipeline run moves to success if all stage runs are successful.
  • FAILURE - A completed pipeline run moves to failure if all stage runs are not successful.
  • CANCELLED - Pipeline run is cancelled by the user.
  • TIMEOUT - The pipeline run has a timed out. This happens when the pipeline has not completed processing even after the timeout period (Default 21 days).
  • INVALID - A pipeline run moves to invalid state when Pipeline run has no stageruns i.e pipeline has zero stages.

Get all Runs for the Pipelines in the Enterprise

SecuritySCAPIAuthToken
Request
query Parameters
status
string

Filter by pipeline run status

Enum: "pending" "queued" "processing" "running" "waiting" "complete" "success" "failure" "cancelled" "invalid" "timeout"
pipeline_name
string

Filter by pipeline name

ordering
string

Sorting pipelines runs based on the field name

Enum: "run_number" "-run_number" "status" "-status" "pipeline__name" "-pipeline__name" "started_at" "-started_at" "ended_at" "-ended_at"
Responses
200

All Runs for the Pipelines in the Enterprise

401

Pipeline run get error

get/v0/runs
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get all Runs for the Pipeline
SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string
ID of the Pipeline


 
query Parameters
status
string
Filter by pipeline run status


 Enum: "pending" "queued" "processing" "running" "waiting" "complete" "success" "failure" "cancelled" "invalid" "timeout"  
ordering
string
Sorting pipelines runs based on the field name


 Enum: "run_number" "-run_number" "status" "-status" "started_at" "-started_at" "ended_at" "-ended_at"  
Responses 
200
All Runs for the Pipeline


401
Pipeline run get error


get/pipelines/v0/pipelines/{pipeline_id}/runs
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Create a Pipeline Run
SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string
ID of the Pipeline


 
Request Body schema: application/json
required
object (PipelineRun_POST) 
 
Responses 
200
Created Pipeline Run


401
Pipeline run create error


post/pipelines/v0/pipelines/{pipeline_id}/runs
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Get Pipeline run by pipeline run id
SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string
ID of the Pipeline


 
pipeline_run_id
required
string
Run Id of pipeline run


 
Responses 
200
Get Pipeline run


401
Operation get error


get/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Update a Pipeline Run
SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string
ID of the Pipeline


 
pipeline_run_id
required
string
Run id of pipeline run


 
Request Body schema: application/json
required
status
string
 Enum: "pending" "queued" "processing" "running" "waiting" "complete" "success" "failure" "cancelled" "invalid" "timeout"  
Responses 
200
Updated Pipeline run information


400
Pipeline Run update error


401
Pipeline Run update error


put/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}
Request samples 
application/json
{
  • "status": "pending"
}
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
Delete a Pipeline Run
SecuritySCAPIAuthToken 
Request 
path Parameters
pipeline_id
required
string
ID of the Pipeline


 
pipeline_run_id
required
string
Run id of pipeline run


 
Responses 
200
Deleted Pipeline run information


400
Pipeline Run update error


401
Pipeline Run update error


delete/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
➔ Next to Stage Runs