HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Gateway List

get
https://{api-base-url}/monitoring/v1/gateways

Get gateways. You can only specify one of group, label parameters.
Possible error_codes for the error responses are

  1. 0001 - General Error.
  2. 0002 - Validation Error. Out of Range value for a query parameter.
  3. 0003 - Validation Error. Unsupported query combination
  4. 0004 - Validation Error. Invalid value for a query parameter
Query Params
string

Filter by group name

string

Filter by Label name

string

Filter by Site name

string

Filter by Gateway status

string

Filter by Gateway MAC address

string

Filter by Gateway Model

string

Comma separated list of fields to be returned. Valid fields are status, ip_address, model, firmware_version, labels, ap_count, usage

boolean

Whether to calculate total Gateways

int32

Pagination offset

int32

Pagination limit. Default is 100 and max is 1000

string

Sort parameter may be one of +serial, -serial, +macaddr, -macaddr. Default is '+serial'

Responses

401

Unauthorized access

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 years ago