/ctrl/device

Provides information about devices that can accept control calls. Each device is described by a set of name/value pairs called device attributes.

Get control device info

Get information about some or all available control devices.

SecurityApiKey
Request
query Parameters
object

If present, return only devices matching the specified attributes. Note that special characters in the query parameter need to URI-encoded to form a valid URL. For example, { needs to be encoded as %7b and } needs to be encoded as %7d.

As a special case, attribute interface is considered to match a device if the device supports the specified interface. The attribute may be specified multiple times to check for the presence of multiple interfaces. For example, the URI-encoded version of attrs={"interface":"relay","interface":"modbus"} would only match devices that provide both the relay and modbus interfaces.

This parameter also supports the index attribute like /ctrl/call does.

Example: attrs={"interface":"relay"}
Responses
200

Device information response

401

Unauthorized response.

get/ctrl/device
Request samples
Response samples
application/json
{
  • "result": [
    ]
}