REST API. Начало работы с REST API компонента «Сессионный агент»

Формат URL-команд для компонента «Сессионный агент»

Общий вид команд реализован следующим образом:

/<module>/<command>,

где:

<module> - наименование модуля, реализованного в REST API. В текущей версии доступен модуль health;

<command> - наименование команды для выполнения.

Пример команды через curl:

Пример команды приведен для обращения по протоколу HTTP. Для использования протокола HTTPS компонент «Сессионный агент» должен быть настроен соответствующим образом, а именно: пути к сертификату и ключу должны быть указаны в конфигурационном файле «Сессионного агента», параметру USE_HTTPS должно быть присвоено значение True.

curl -X 'GET' \
  'http://agent.termidesk.local:31000/health/metrics' \
  -H 'accept: application/json' \
  -H 'Authorization: Token HjXcGpVu8bSPEoq4NQ0qo0KpdfwoEbuTbElG3J7uSFr2aK3oPtNqlnw4VEARS2HY'

где:

agent.termidesk.local - сетевой адрес или полное доменное имя узла компонента «Сессионный агент»;

31000 - порт для запросов проверки состояния, для компонента «Сессионный агент» - 31000;

Authorization: Token - токен, определенный в переменной METRICS_ACCESS_KEY конфигурационного файла «Сессионного агента»: /etc/opt/termidesk-session-agent/session_agent.ini (для ОС Astra Linux Special Edition (Server)) или %ProgramData%\UVEON\Termidesk Session Agent\session_agent.ini (для ОС Microsoft Windows Server).