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

Total Clients Count

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

Get the total clients connected
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
  5. 0005 - Validation Error. Missing required query parameter
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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 network name. Field supported for wireless clients only

string

Filter by Mobility Controller serial number

string

Filter by Switch stack_id

string

Filter by device type. Value can be either "AP" or "Switch"

string

Filter by Ap or serial

string

Filter by band. Value can be either "2.4", "5" or "6". Valid only when serial parameter is specified.

integer

Filter by radio_number (0, 1 or 2). Valid only when serial parameter is specified. If band is provided and radio_number is not provided then radio_number is defaulted to 0, 1 and 2 for band 5, 2.4 and 6 respectively.

int32

Need information from this timestamp. Timestamp is epoch in seconds. Default is current timestamp minus 3 hours

int32

Need information to this timestamp. Timestamp is epoch in seconds. Default is current timestamp

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago