Add devices to a device group

POST

/api/v1/device-groups/{id}/members

curl --request POST \
  --url http://localhost:3000/api/v1/device-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/members \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "deviceIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

• Development
• Production

Idempotent: devices that are members already are counted in alreadyMembers. Refused as a whole with 400 when any device is not a live device of the organization.

Authorizations

• api-key
• bearer

Parameters

Path Parameters

id

required

string format: uuid

Device group UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Request Body^required

Media typeapplication/json

object

deviceIds

required

Devices to add or remove (1 to 1000, unique)

Array<string>

>= 1 items <= 1000 items

Example^generated

{
  "deviceIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

200

Media typeapplication/json

object

added

required

Devices newly added

number

alreadyMembers

required

Devices that were members already (ignored)

number

Example^generated

{
  "added": 1,
  "alreadyMembers": 1
}

400

Invalid body or unknown device

403

Forbidden — caller lacks required permission

404

Group not found