Find sensor by name

GET 
/devices/:deviceId

Describe a sensor in your tenancy.

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

Request

Path Parameters

deviceId stringrequired
The device to describe.
Example: G111045

Responses

200

An object of the device metadata.

application/json

Schema

Schema

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.

Example (from schema)

{
  "heartbeat": 1692348210,
  "name": "G111045",
  "path": "Site 4/Stack 11/Row 7"
}

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...