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

List all Networks

get
https://{api-base-url}/monitoring/v2/networks

Get a list of networks. You can only specify one of group, swarm_id, label, site parameters.
Possible error_codes for the error responses are

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

Filter by group name

string

Filter by Swarm ID. Field supported for AP clients only

string

Filter by Label name

string

Filter by Site name

boolean

Whether to calculate client count per SSID

string

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

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