Theme

Devices ​

API endpoints for Devices management in IOTSP.

Add device ​

http
POST /v1/iotsp/devices

Headers ​

  • origin (required)
  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Add deviceRequest {
  id: string;
  specs: {
    name: string;
    model: string;
    version: string;
    IMEI: string
  };
}

Example:

json
{
  "id": "862061041674804",
  "specs": {
    "name": "okai",
    "model": "ES600P",
    "version": "zk301",
    "IMEI": "862061041674804"
  }
}

Get device info ​

http
GET /v1/iotsp/devices/:id

Headers ​

  • origin (required)
  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Find device ​

http
GET /v1/iotsp/devices/find?query=862061041674804

Headers ​

  • origin (required)
  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Get all devices ​

http
GET /v1/iotsp/devices

Headers ​

  • origin (required)
  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Update device information ​

http
PATCH /v1/iotsp/devices/:id

Headers ​

  • origin (required)
  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Update device informationRequest {
  specs.model: string;
  tags: string[];
}

Example:

json
{
  "specs.model": "ES400",
  "tags": [
    "virtual"
  ]
}

Update device status ​

http
PATCH /v1/iotsp/devices/:id/:status

Headers ​

  • origin (required)
  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Remove device ​

http
DELETE /v1/iotsp/devices/:id

Headers ​

  • origin (required)
  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)