Skip to main content

Alerts API 1.6.0

Alert events and alert state operations.

Base path: https://{controller_ip}/api/v1. API description version: 1.6.0.

Examples use placeholder values for passwords, tokens, UUIDs, addresses and secrets. Replace them with values from your controller before sending requests.

Section methods​

MethodPath
GET/alerts/access_points/{uuid}/count
GET/alerts/sortByAccessPoint
GET/alerts/violations
DELETE/alerts/access_points/{uuid}
DELETE/alerts/{uuid}

GET /alerts/access_points/{uuid}/count​

Section: Alerts.

Returns a count for the alerts endpoint /alerts/access_points/{uuid}/count.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/alerts/access_points/{uuid}/count" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/alerts/access_points/{uuid}/count" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "count": 12
}

GET /alerts/sortByAccessPoint​

Section: Alerts.

Returns data for the alerts endpoint /alerts/sortByAccessPoint.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/alerts/sortByAccessPoint" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/alerts/sortByAccessPoint" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/alerts/sortByAccessPoint"
  }
}

GET /alerts/violations​

Section: Alerts.

Returns data for the alerts endpoint /alerts/violations.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/alerts/violations" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/alerts/violations" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/alerts/violations"
  }
}

DELETE /alerts/access_points/{uuid}​

Section: Alerts.

Deletes data for the alerts endpoint /alerts/access_points/{uuid}.

Request example​

curl -k -X DELETE "https://{controller_ip}/api/v1/alerts/access_points/{uuid}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X DELETE "https://{controller_ip}/api/v1/alerts/access_points/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "deleted": true
}

DELETE /alerts/{uuid}​

Section: Alerts.

Deletes data for the alerts endpoint /alerts/{uuid}.

Request example​

curl -k -X DELETE "https://{controller_ip}/api/v1/alerts/{uuid}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X DELETE "https://{controller_ip}/api/v1/alerts/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "deleted": true
}