Skip to content

Add a Device Group to the Target List
Stable

Request

Adds a Device Group to a Pipeline Target List.

Links an existing Device Group to the specified Target List, so that pipeline stages using this Target List will act on every device currently in the group. Not recommended for pipelines that are currently running.

About Target List Device Groups Target Lists can scope a pipeline stage to individual device Targets, whole Device Groups, or both. Adding a Device Group is the fastest way to target a large, already-organized set of devices without adding them one at a time.

Security
pipelines_SCAPIAuthToken
Path
pipeline_idstringrequired

ID of the Pipeline

targetlist_idstringrequired

ID of the Target List

Bodyapplication/jsonrequired
device_group_idstring, (uuid)

UUID of the Device Group

cURL
curl -i -X POST \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "device_group_id": "3b4f0cb7-4e98-4573-a42e-df126a0072f5"
  }'

Responses

Added Device group

Bodyapplication/json
idstringread-only
device_group_idstring
target_list_idstring
created_bynumber, (int32)
updated_bynumber, (int32)
created_atstring, (date-time)
updated_atstring, (date-time)
Response
{
  "id": "string",
  "device_group_id": "string",
  "target_list_id": "string",
  "created_by": 0,
  "updated_by": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}