ZeroKey

Device Control

The device control operations provide a hardware abstraction layer to enable directly addressing and controlling end-devices, without regard to their specific model or type.

Update device settings

SecurityOAuth2 or ApiKey
Request
path Parameters
address
required
string

Address of the device (usually it's MAC address)

Request Body schema: application/json

Update device settings.

AlertState
string

The alert state of a device indicates whether it is currently alarming by flashing it's alarm LED, and exciting its buzzer and vibration motor.

Enum: "off" "active"
Responses
200

Response success

400

Malformed request.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden. Current token does not have the necessary authority for the operation.

404

Resource was not found.

422

Invalid data was sent.

put/devices/{address}
Request samples
application/json
{
  • "AlertState": "active"
}
Response samples
application/json
{
  • "status": 200,
  • "success": true
}

Set the alert state of the device

SecurityOAuth2 or ApiKey
Request
path Parameters
address
required
string

Address of the device (usually it's MAC address)

Request Body schema: application/json

Set the alert state of a device

AlertState
string

The alert state of a device indicates whether it is currently alarming by flashing it's alarm LED, and exciting its buzzer and vibration motor.

Enum: "off" "active"
Responses
200

Response success

400

Malformed request.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden. Current token does not have the necessary authority for the operation.

404

Resource was not found.

422

Invalid data was sent.

put/devices/{address}/alertState
Request samples
application/json
{
  • "AlertState": "active"
}
Response samples
application/json
{
  • "status": 200,
  • "success": true
}
➔ Next to Module Management