Skip to content

Create a Pipeline stage
Stable

Request

Adds a new Stage to a Pipeline.

Send a POST request with the Stage's details to append a new ordered step to the pipeline; the response returns the created Stage object, which you then attach Target Lists and Operation Lists to.

About Stages

A Stage represents one ordered step in a Pipeline's execution. A newly created Stage has no Target Lists or Operation Lists attached by default, so a Stage Run produced from it would be marked INVALID (no targets or no operations) until those are added.

Workflow

  1. Create the Stage
  2. Attach one or more Target Lists (directly or via Device Groups) to define which devices it targets
  3. Attach one or more Operation Lists to define what actions it performs
Security
pipelines_SCAPIAuthToken
Path
pipeline_idstringrequired

ID of the Pipeline

Bodyapplication/jsonrequired
namestringrequired
descriptionstring
timeout_secondsnumber, (int32)
cURL
curl -i -X POST \
  'https://api.esper.io/_mock/openapi/pipelines/v0/pipelines/{pipeline_id}/stages/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "timeout_seconds": 0
  }'

Responses

Pipelines stages create response

Bodyapplication/json
codeinteger
messagestring
contentobject(pipelines_Stage)
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "id": "string",
    "enterprise_id": "string",
    "pipeline_id": "string",
    "description": "string",
    "name": "string",
    "timeout_seconds": 0,
    "created_by": 0,
    "updated_by": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}