HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
API Reference

The API provides detailed information of a Gateway

This API retrieves detailed information about a specific gateway linked to a particular site. It provides gateway related details such as MAC address, name, status, uplinks, ports, vlans based on the gateway's serial number associated with the site.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 16

Serial number of an gateway device.

Query Params
string
required
length ≤ 256

OData Version 4.0 filter string (limited functionality). Supported fields and operators are in the below given table.

FieldOperators
siteIdeq

The operators are implemented as follows:

  • eq: Only values exactly matching the given value are returned.
Responses

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