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

События аудита API 1.6.0

Журнал аудита и пользовательские события аудита.

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

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

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

МетодПуть
GET/audit_events/
GET/audit_events/count
GET/audit_events/types
GET/audit_events/{uuid}
POST/audit_events/user_defined/
PUT/audit_events/user_defined/{uuid}
DELETE/audit_events/user_defined/{uuid}

GET /audit_events/​

Раздел: События аудита.

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

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

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

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

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

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

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

GET /audit_events/count​

Раздел: События аудита.

Возвращает количество событий аудита в системе за определенный период времени.

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

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

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

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

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

{
  "count": 12
}

GET /audit_events/types​

Раздел: События аудита.

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

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

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

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

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

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

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/audit_events/types"
  }
}

GET /audit_events/{uuid}​

Раздел: События аудита.

Возвращает данные конкретного события аудита по uuid.

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

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

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

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

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

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/audit_events/{uuid}"
  }
}

POST /audit_events/user_defined/​

Раздел: События аудита.

Добавляет пользовательское событие с типом «Аудит» (audit_events).

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

curl -k -X POST "https://{IP_контроллера}/api/v1/audit_events/user_defined/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_audit",
  "message": "Внешнее событие аудита"
}'

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

{
  "type": "custom_audit",
  "message": "Внешнее событие аудита"
}

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

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

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

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /audit_events/user_defined/{uuid}​

Раздел: События аудита.

Редактирует существующее пользовательское событие аудита.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/audit_events/user_defined/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_audit",
  "message": "Внешнее событие аудита"
}'

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

{
  "type": "custom_audit",
  "message": "Внешнее событие аудита"
}

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

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

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

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /audit_events/user_defined/{uuid}​

Раздел: События аудита.

Удаляет пользовательское событие аудита.

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

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

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

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

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

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