Skip to content

Create a Target Runs for Stage Run
Stable

Request

Creates a new Target Run for a Stage Run.

Adds a device-level execution record to the specified Stage Run, identifying the Target (device) that the stage should now also act on. Not recommended for pipelines that are currently running.

About Target Runs A Target Run is the execution record of one device (Target) within a Stage Run. Creating one directly is an advanced operation, typically used to add a device to an in-progress or newly created stage run outside of the normal automatic scoping from the stage's Target Lists.

Key Fields / Query Parameters

  • stage_run_id — UUID of the Stage Run to add the Target Run to
  • target_id — UUID of the Target (device entry) this run applies to
  • device_name — Display name of the device
  • device_alias — Display alias of the device
Security
pipelines_SCAPIAuthToken
Path
stage_run_idstringrequired

Stage run Id

Bodyapplication/jsonrequired
target_idstring, (uuid)required
device_namestring
device_aliasstring
cURL
curl -i -X POST \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/stageruns/{stage_run_id}/targetruns/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9",
    "device_name": "string",
    "device_alias": "string"
  }'

Responses

Created Target Runs

Bodyapplication/json
codeinteger
messagestring
contentArray of objects(pipelines_TargetRun)
Response
{
  "code": 0,
  "message": "string",
  "content": [
    { … }
  ]
}