KKonsol Developers

Decommission a device

POST
/integration/v1/devices/{id}/decommission

Retires the device permanently. It can no longer connect to Konsol and cannot be given an activation code. Nothing undoes this. The device keeps its record and history but gives up its device_identifier, so the same hardware can be registered again as a new device with POST /integration/v1/devices.

A device that is still set up for a product is refused with 409. Release it first with DELETE /integration/v1/devices/{id}/products/{product_code}. Repeating the call on a decommissioned device returns it unchanged.

Authorization

integrationKey
headerAuthorizationBearer <token>

Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>. Konsol issues it.

Path Parameters

id*string
Formatuuid

Response Body

The decommissioned device

application/json
  1. response
id*string
Formatuuid
device_identifier*string
display_name?string|null
status*string

not_activated: registered, and no activation code has been entered on it. activated: in use. suspended: paused in the Konsol portal. decommissioned: retired permanently.

Value in"not_activated""activated""suspended""decommissioned"
activated_at?|

When an activation code was first entered on the device.

Formatdate-time
trading_ids*array<>

The tradings the device is currently assigned to.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X POST 'https://api.konsol.my/integration/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/decommission'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "device_identifier": "string",  "display_name": "string",  "status": "not_activated",  "activated_at": "2019-08-24T14:15:22Z",  "trading_ids": [    "f974492b-bfc0-4d85-99be-88d5e8ec0ac6"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}