Devices

Read

GET https://interay.io/api/v1/devices/get

Read device details

type

object

properties

  • device

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

POST https://interay.io/api/v1/devices/set

Write device details

type

object

properties

  • device

The device unique identifier, Unique ID or External key

type

string

  • values

The device details

type

object

properties

  • enabled

Enabled

type

bool

  • name

Name

type

string

  • key

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