Skip to content

Update a Pipeline Run
Stable

Request

Updates a Pipeline Run for a specific pipeline.

Send a PUT request with a new status value to transition the run programmatically; the request body accepts a single status field using the same enum values as the run lifecycle (pending, queued, processing, running, waiting, complete, success, failure, cancelled, invalid, timeout), and the response returns the updated Pipeline Run object.

About Pipeline Runs

A Pipeline Run is the record created each time a Pipeline executes, progressing through Esper's orchestration lifecycle from PENDING through QUEUED, PROCESSING, RUNNING, and WAITING to COMPLETE with a SUCCESS or FAILURE outcome (or CANCELLED, TIMEOUT after 21 days, or INVALID if the pipeline has zero stages). Each Pipeline Run produces one Stage Run per stage in the pipeline.

Key Fields / Query Parameters

  • status — the lifecycle status to set on the run

Common Use Cases

  • Cancel an in-progress Pipeline Run by setting status to cancelled
Security
pipelines_SCAPIAuthToken
Path
pipeline_idstringrequired

ID of the Pipeline

pipeline_run_idstringrequired

Run id of pipeline run

Bodyapplication/jsonrequired
statusstring
Enum:"pending""queued""processing""running""waiting""complete""success""failure""cancelled""invalid"
cURL
curl -i -X PUT \
  'https://api.esper.io/_mock/openapi/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "pending"
  }'

Responses

Updated Pipeline run information

Bodyapplication/json
codeinteger
messagestring
contentobject(pipelines_PipelineRun)
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "id": "string",
    "enterprise_id": "string",
    "run_number": 0,
    "pipeline_id": "string",
    "pipeline_name": "string",
    "status": "pending",
    "status_meta": {},
    "created_by": 0,
    "updated_by": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "started_at": "2019-08-24T14:15:22Z",
    "ended_at": "2019-08-24T14:15:22Z"
  }
}