API Reference

get gateways

get
https://api.data.everactive.com/ds/v1/evergateways

Retrieve a list of gateways in your installation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter the gateways returned by the gateway flavor. An exact match is used for this filter.

Allowed:
string

The ID of a specific gateway to return. An exact match is used for this filter.

string

Filter the returned Evergateways by the location property. A case-insensitive database match string. Returns all gateways whose location value matches this string.

string

Filter the returned Evergateways by the name property. A case-insensitive database match string. Returns all gateways whose name value matches this string.

int32
required
≥ 1
Defaults to 1

A one-based index for the first page number to return from a paginated call.

int32
≥ 1
Defaults to 50

The maximum number of items to return per page.

string

Filter the returned Evergateways by the serialNumber property. A case-insensitive database match string. Returns all gateways whose serialNumber value matches this string.

string

Filter the returned Evergateways by the softwareVersion property. A case-insensitive database match string. Returns all gateways whose softwareVersion value matches this string.

string
enum
Defaults to last-reading

The field by which to sort the returned list of gateways. If omitted, the list is in descending sort order by the lastReading timestamp.

string
enum

The direction to sort the list of results, ascending or descending.

Allowed:
Responses

401

The request did not include the correct authorization or the included authorization has expired.

403

The requested resource is not accessible to the currently authenticated client.

Updated 7 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago