List all sensors

GET 
/devices

Returns a list of sensors in your tenancy.

Required scope(s): [devices.registry:read]

Request

Query Parameters

group string

If specified, only sensors in this Device Group will be returned.

recursive boolean

Default value: true

If true, sensors in child Device Groups relative to your specified Device Group will be returned. If false, will return the sensors in that Device Group alone.

Ignored if group is not specified.

limit integer

Possible values: <= 100

Default value: 50

Pagination parameter; the number of returned sensors is limited to this value. Any value greater than 100 will be ignored.

skip integer

Default value: 0

Pagination parameter; this number of sensors will be skipped before the list is returned. Any value below 0 will be ignored.

Responses

200

An array of device metadata.

application/json

Schema

Schema

devices object[]
Array [
heartbeat integer
The latest device heartbeat, in seconds since epoch.
name string
The device ID.
path string
The location of this device within your device group hierarchy.
]
remaining integer

The number of sensors remaining for the list operation based on your input pagination parameters.

Example (from schema)

{
  "devices": [
    {
      "heartbeat": 1692348210,
      "name": "G111045",
      "path": "Site 4/Stack 11/Row 7"
    }
  ],
  "remaining": 10
}

400

Your input parameters are invalid. A message is returned explaining the issue.

application/json

Schema

Schema

object

Example (from schema)

{}

401

You are not authorized to perform this request.

application/json

Schema

Schema

object

Example (from schema)

{}

500

An internal server error. Please contact Gardin Support for further assistance.

application/json

Schema

Schema

object

Example (from schema)

{}

Loading...