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

(Deprecated) List Events

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

Get a list of events. You can only specify one of group, swarm_id, label, serial, macaddr 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
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

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

int32

Pagination offset

int32

Pagination limit. Default is 100 and max is 1000

string

Filter by switch serial number

string

Filter by event type

integer

Filter by event number

string

Filter by event level

string

Filter by event description

string

Filter by event category

string

Filter by client MAC address

string

Comma separated list of fields to be returned. Valid fields are number, level

boolean

Whether to calculate total events

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