Установка приложения с REST API

Для управления приложением через REST API нужно установить Kaspersky Endpoint Security c поддержкой REST API. Если вы управляете Kaspersky Endpoint Security через REST API, управлять приложением с помощью Kaspersky Security Center невозможно.

Подготовка к установке приложения с поддержкой REST API

Для безопасной работы Kaspersky Endpoint Security с REST-клиентом вам нужно настроить идентификацию запросов. Для этого вам нужно установить сертификат и в дальнейшем подписывать полезные данные каждого запроса.

Для создания сертификата вы можете использовать, например, OpenSSL.

Пример:

$ openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 1825 -nodes

Используйте алгоритм шифрования RSA и размер ключа 2048 бит и более.

В результате вы получите сертификат cert.pem и закрытый ключ key.pem.

Установка приложения с поддержкой REST API

Чтобы установить Kaspersky Endpoint Security c поддержкой REST API, выполните следующие действия:

  1. Запустите интерпретатор командной строки cmd от имени администратора.
  2. Перейдите в папку, в которой расположен дистрибутив Kaspersky Endpoint Security версии 11.2.0 или выше.
  3. Установите Kaspersky Endpoint Security со следующими параметрами:
    • RESTAPI=1
    • RESTAPI_User=<Имя пользователя>

      Имя пользователя для управления приложением через REST API. Введите имя пользователя в формате <DOMAIN>\<UserName> (например, RESTAPI_User=COMPANY\Administrator). Вы можете управлять приложением через REST API только под этой учетной записью. Для работы с REST API вы можете выбрать только одного пользователя.

    • RESTAPI_Port=<Порт>

      Порт для управления приложением через REST API. По умолчанию используется порт 6782. Убедитесь, что порт свободен. Необязательный параметр.

    • RESTAPI_Certificate=<Путь к сертификату>

      Сертификат для идентификации запросов (например, RESTAPI_Certificate=C:\cert.pem).

      Вы можете установить сертификат после установки приложения или обновить сертификат после истечения срока действия.

      Как установить сертификат для идентификации запросов REST API

    • AdminKitConnector=1

      Управление приложением с помощью систем администрирования. По умолчанию управление разрешено.

    Также вы можете задать параметры работы с REST API с помощью файла setup.ini.

    Пример:

    setup_kes.exe /pEULA=1 /pPRIVACYPOLICY=1 /pKSN=1 /pALLOWREBOOT=1 /pAdminKitConnector=1 /pRESTAPI=1 /pRESTAPI_User=COMPANY\Administrator /pRESTAPI_Certificate=C:\cert.pem /s

В результате вы сможете управлять приложением через REST API. Для проверки работы откройте документацию REST API с помощью GET-запроса.

Пример:

GET http://localhost:6782/kes/v1/api-docs

Если вы установили приложение с поддержкой REST API, Kaspersky Endpoint Security автоматически создает в параметрах Веб-Контроля разрешающее правило доступа к веб-ресурсам Служебное правило для REST API. Это правило нужно для обеспечения постоянного доступа REST-клиента к Kaspersky Endpoint Security. Например, если вы ограничили доступ пользователя к веб-ресурсам, это не повлияет на управление приложением через REST API. Мы рекомендуем не удалять правило и не изменять параметры правила Служебное правило для REST API. Если вы удалили правило, Kaspersky Endpoint Security восстановит правило после перезапуска приложения.

В начало