Bulk retire devices

Retire multiple devices in bulk. The request is processed asynchronously: the response is 202 Accepted with a Location header (and the same URL in the body's location) that points to Get operation. Poll that URL until the operation's status is Completed or Failed.

deviceIds is required and must be non-empty. Every ID must be non-blank, unique within the request, belong to this account and not already be retired; otherwise the request is rejected with 400 Bad Request listing each offending device ID. There is no maximum number of devices per request.

Path Params
string
required

The account ID associated with the devices.

Body Params

The devices to retire.

Devices to retire.

deviceIds
array of strings, unique
required
length ≥ 1

IDs of the devices to retire. Must be non-empty and unique, and every device must belong to the account and not already be retired.

deviceIds*
Responses

401

Unauthorized. The access token is missing, invalid or expired. Returned by the gateway with an empty body.

403

Forbidden. The caller lacks permission, or the account is unknown, belongs to another tenant or is inactive. Returned by the gateway with an empty body.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json