Skip to content

Bulk delete devices

DELETE
/api/v1/groups/devices
curl --request DELETE \
--url http://localhost:3000/api/v1/groups/devices \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "labelSelector": { "environment": "development", "status": "deprecated" } }'

Soft deletes devices matching a selector.

Media type application/json
object
labelSelector
required

Label selector to match devices for deletion

object
key
additional properties
string
Example
{
"environment": "development",
"status": "deprecated"
}

Devices deleted successfully

Media type application/json
object
deleted
required

Number of devices deleted

number
deviceIds
required

IDs of deleted devices

Array<string>
Example
{
"deleted": 5,
"deviceIds": [
"550e8400-e29b-41d4-a716-446655440000"
]
}

Bad Request

Unauthorized

Forbidden — caller lacks required permission