ConstantsEvents

listDeviceEventsDefinitions

GET
/api/v1/const/device_events

Return device event definitions used by device event search and count APIs and the device-events webhook topic, including event keys and metadata.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Response Body

curl -X GET "https://example.com/api/v1/const/device_events"
[  {    "description": "AP was assigned to a site",    "display": "AP Assigned",    "example": {      "ap": "5c5b35000001",      "audit_id": "e9a88814-fa81-5bdc-34b0-84e8735420e5",      "org_id": "2818e386-8dec-2562-9ede-5b8a0fbbdc71",      "site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b",      "timestamp": 1552408871,      "type": "AP_ASSIGNED"    },    "key": "AP_ASSIGNED"  }]