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

List Access Points

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

Get access points. 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. 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 Swarm ID. Field supported for AP clients only

string

Filter by Label name

string

Filter by Site name

string

Filter by AP status

string

Filter by AP serial number

string

Filter by AP MAC address

string

Filter by AP Model

string

Filter by Mobility Controller serial number

string

Comma separated list of fields to be returned. Valid fields are status, ip_address, model, firmware_version, swarm_master, labels, radios, ap_deployment_mode, public_ip_address, site, last_modified, ap_group, subnet_mask, mesh_role

boolean

Whether to calculate total APs

boolean

Whether to calculate client count per AP

boolean

Whether to calculate ssid count per AP

boolean

Whether to show AP cpu_utilization, uptime, mem_total, mem_free, mesh_role, mode.

int32

Pagination offset

int32

Pagination limit. Default is 100 and max is 1000

string

Sort parameter may be one of +serial, -serial, +macaddr, -macaddr, +swarm_id, -swarm_id. 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