REST API

В KUMA можно обращаться из сторонних решений с помощью API. KUMA REST API работает через HTTP и представляет набор методов запрос/ответ. Поддерживаются две версии:

• REST API v1 - в запросах не используется массив FQDN.
• REST API v2 - в запросах используется массив FQDN.
• REST API v2.1 - в запросах используется массив FQDN.

Запросы REST API необходимо отправлять по следующему адресу:

https://<FQDN Ядра KUMA>/api/<Версия API>/<запрос>

Пример: https://kuma.example.com:7223/api/v1 https://kuma.example.com:7223/api/v2 https://kuma.example.com:7223/api/v2.1

По умолчанию для запросов используется порт 7223. При необходимости порт можно изменить.

Чтобы изменить порт, используемый для запросов REST API:

1. Войдите в ОС сервера, на котором установлено Ядро KUMA.
2. В файле /etc/systemd/system/multi-user.target.wants/kuma-core.service измените следующую строку, подставив нужный порт:

   ExecStart=/opt/kaspersky/kuma/kuma core --external :7220 --internal :7210 --mongo mongodb://localhost:27017 --rest <требуемый номер порта для запросов REST API>

3. Перезапустите KUMA, выполнив последовательно следующие команды:
   1. systemctl daemon-reload
   2. systemctl restart kuma-core

Для запросов REST API используется новый порт.

Убедитесь, что порт доступен и не закрыт межсетевым экраном.

Заголовок для аутентификации: Authorization: Bearer <токен>

Формат данных по умолчанию: JSON

Формат даты и времени: RFC 3339

Интенсивность запросов: не ограничена

В этом разделе справки Создание токена Настройка прав доступа к API Авторизация API-запросов Стандартная ошибка Операции REST API v1 Операции REST API v2 Операции REST API v2.1

В начало