Properties

Read

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

Read properties

type

object

properties

  • device

The device unique identifier, Unique ID or External key

type

string

Example request

GET https://interay.io/api/v1/properties/get?device=00000000-0000-0000-0000-000000000000

Example response

{
        "interval": 60,
        "software_version": "v1.0"
}

POST https://interay.io/api/v1/properties/get

Read properties

type

object

properties

  • device

The device unique identifier, Unique ID or External key

type

string

Example request

{
        "device": "00000000-0000-0000-0000-000000000000"
}

Example response

{
        "interval": 60,
        "software_version": "v1.0"
}

Write

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

Write properties

type

object

properties

  • device

The device unique identifier, Unique ID or External key

type

string

  • values

The device properties

type

object

patternProperties

  • ^[a-z0-9][a-z0-9_-]+$

type

boolean / number / string

Notes

Only specified properties with a different value are overwritten. Existing non-specified properties are preserved.

To get a list of available property names either use Properties Read or hover over the labels in Devices Properties.

Example request

{
        "device": "00000000-0000-0000-0000-000000000000",
        "values": {
                "imei": "AABBBBBBCCCCCCD",
                "software_version": "v2.0"
        }
}

Example response

none