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

GetSecurityEvents

Возвращает список событий безопасности в ящике.

GET /V1/GetSecurityEvents

Параметры запроса

  • boxId — идентификатор ящика организации в формате GUID.
  • afterIndexKey — ключ для постраничного получения списка найденных событий, указывающий на начало очередной страницы. Ключ может содержать недопустимые символы, поэтому должен быть закодирован в URL-формат. Необязательный параметр.
  • count — максимальное количество элементов, возвращаемых на одной странице в ответе. Не влияет на общее количество найденных событий. Принимает значения от 1 до 1000, по умолчанию равен 100. Необязательный параметр.

Заголовки запроса

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен.
  • 405 — используется неподходящий HTTP-метод.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

Тело ответа содержит список событий безопасности, представленный структурой SecurityEventList.

Примеры использования

Пример HTTP-запроса:

GET /V1/GetSecurityEvents?boxid={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json

Пример тела ответа:

{
"Events": [
{
"EventId": "fbb08560-12f8-5617-8176-272eec9a4b7d",
"EventType": "MalwareDetected",
"Target": {
"Type": "Document",
"Document": {
"LetterId": "105fa330-50a6-461f-baea-3551b588f0f6",
"DocumentId": "701070a6-afeb-41ae-ba7e-c421f0a46959"
}
},
"TimestampTicks": 639124382396812667,
"Details": "Content: Malware found",
"IndexKey": "AAEAAAAAAAAAAQ=="
}
],
"LastIndexKey": "AAEAAAAAAAAAAQ=="
}

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года