Skip to content

Attach the Target List to the Stage
Stable

Request

Attaches an existing Target List to a Pipeline stage.

Links a Target List (identified by target_list_id) to the specified stage, so that the stage will act on the devices or device groups contained in that list when the pipeline runs.

About Stage Target Lists Pipelines orchestrate multi-step device operations through Stages, each of which executes against one or more Target Lists. This endpoint is how a Target List that already exists on the pipeline gets scoped to a specific stage.

Key Fields / Query Parameters

  • stage_id — UUID of the Stage to attach the Target List to
  • target_list_id — Required — UUID of an existing Target List to attach
Security
pipelines_SCAPIAuthToken
Path
stage_idstringrequired

ID of the Stage

Bodyapplication/jsonrequired
target_list_idstring, (uuid)required
cURL
curl -i -X POST \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/stages/{stage_id}/targetlists/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "target_list_id": "e020bfe9-7c71-4403-800b-700dad22bfd2"
  }'

Responses

Attach target list to a Stage

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