Перейти к основному содержимому

Тревоги API 1.6.0

Тревоги, нарушения и операции по точкам прохода.

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.6.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
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​

Раздел: Тревоги.

Возвращает количество тревог на точке прохода.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/alerts/access_points/{uuid}/count" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/alerts/access_points/{uuid}/count" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "count": 12
}

GET /alerts/sortByAccessPoint​

Раздел: Тревоги.

Возвращает тревогу с отсортированными по UUID точками прохода.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/alerts/sortByAccessPoint" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/alerts/sortByAccessPoint" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

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

GET /alerts/violations​

Раздел: Тревоги.

Возвращает количество тревог на точке прохода с параметрами.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/alerts/violations" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/alerts/violations" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

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

DELETE /alerts/access_points/{uuid}​

Раздел: Тревоги.

Eдаляет тревожное событие точки прохода.

Пример запроса​

curl -k -X DELETE "https://{IP_контроллера}/api/v1/alerts/access_points/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/alerts/access_points/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

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

DELETE /alerts/{uuid}​

Раздел: Тревоги.

Удаляет тревожное событие по uuid.

Пример запроса​

curl -k -X DELETE "https://{IP_контроллера}/api/v1/alerts/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/alerts/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

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