Gateway Hardware API

As of 05/2023, the VergeSense /hardware API now has a new endpoint: /hardware/gateways. This endpoint shares all the same keys and pagination details as the existing /hardware/sensors endpoint, but it is specific to gateway devices.

The Gateway Hard API fetches all gateways. Response conforms to the JSON API spec https://jsonapi.org/.Responses are limited to 1,000 gateway after which pagination will take place.

Response

Field Description Data Type
data Array of hardware gateway models. Array of Hardware Gateway Models (see below)
included Included relationships. Building
Floor
links Pagination links. Links

Hardware Gateway Model

Field Description Data Type
id Unique identifier for the VergeSense hardware gateway. Ex: C0300A1234-01234 String
type Gateway String
attributes.model VergeSense hardware model. Ex: rigado String
attributes.firmware Firmware version of the default (if available). `String
attributes.mac_address Mac Address of the gateway. `String
relationships.building The building that the gateway is located within. Building details included in the included top-level response key. Object
relationships.floor The floor that the gateway is installed on. Floor details included in the included top-level response key. Object

Updated

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.