Devices
Read
Read device details | ||
type | object | |
properties | ||
| The device unique identifier, Unique ID or External key | |
type | string | |
Example request
GET https://interay.io/api/v1/devices/get?device=00000000-0000-0000-0000-000000000000
Example response
{
"displayName": "Docs (docs)",
"key": "docs",
"uid": "00000000-0000-0000-0000-000000000000",
"enabled": true,
"link": "https://interay.io/admin/devices/00000000-0000-0000-0000-000000000000",
"name": "Docs",
}
Write
Write device details | |||
type | object | ||
properties | |||
| The device unique identifier, Unique ID or External key | ||
type | string | ||
| The device details | ||
type | object | ||
properties | |||
| Enabled | ||
type | bool | ||
| Name | ||
type | string | ||
| External key | ||
type | string | ||
Notes
Only specified details with a different value are overwritten. Existing non-specified details are preserved.
Example request
{
"device": "00000000-0000-0000-0000-000000000000",
"values": {
"enabled": true,
"name": "Docs",
"key": "docs"
}
}
Example response
none