Команды компонента «Универсальный диспетчер»

Доступные команды модуля «agent»

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «agent»).

Таблица 1. Перечень URL-команд модуля «agent»
URL-команда Тип Описание

/api/agent/v7.0/{uuid}/assistant/events/connect

POST

Добавление записи о подключении к сеансу или отключении от сеанса «Удаленного помощника» в журнал РМ

/api/agent/v7.0/{uuid}/events/connected

PATCH

Уведомление о подключении пользователя к РМ

/api/agent/v7.0/{uuid}/events/disconnected

PATCH

Уведомление об отключении пользователя от РМ

/api/agent/v7.0/{uuid}/events/loggedin

PATCH

Уведомление о входе пользователя

/api/agent/v7.0/{uuid}/events/loggedout

PATCH

Уведомление о выходе пользователя

/api/agent/v7.0/{uuid}/legacy/osmanager

PATCH

Обработка внутренних процессов РМ

/api/agent/v7.0/{uuid}/log

PATCH

Добавление записи в журнал РМ

/api/agent/v7.0/{uuid}/notifyComms

PATCH

Сохранение URL для коммуникации в параметрах РМ

/api/agent/v7.0/{uuid}/policies

GET

Получение информации о политиках РМ

/api/agent/v7.0/{uuid}/scripts

GET

Получение информации о скриптах РМ

/api/agent/v7.0/{uuid}/service_info

GET

Получение информации о РМ

/api/agent/v7.0/{uuid}/settings

GET

Получение информации о настройках РМ

/api/agent/v7.0/{uuid}/version

PATCH

Сохранение версии агента

/api/agent/v7.0/boot_mode

GET

Запрос режима загрузки при работе ВМ с сетевым диском

/api/agent/v7.0/boot_script

GET

Запрос скрипта загрузки по MAC при работе ВМ с сетевым диском

/api/agent/v7.0/init

POST

Инициализация агента на РМ

/api/agent/v7.0/qcow_action

GET

Запрос на действие с qcow2 диском при выходе пользователя из ОС.

Используется для РМ, созданных на основе шаблона «Сетевая загрузка» в поставщике ресурсов VMware.

Возможные значения повторяют значения политики «Действие при выходе пользователя из ОС (RDP, SPICE, TERA)»:

  • «1» - «Не задано»;

  • «2» - «Удалить рабочее место»;

  • «3» - «Не сохранять изменения»;

  • «4» - «Не сохранять изменения и назначение ВРМ»;

  • «5» - «Перезагрузить ВРМ»

/api/agent/v7.0/test

PATCH

Запрос проверки корректности мастер-ключа

/api/agent/v7.0/settings

GET

Получение настроек компонента «Ретранслятор»

Доступные команды модуля «aggregator»

Команды, связанные со списками фондов, ассоциированных с определенными доменами аутентификации

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «aggregator», связанных с доменами аутентификации). Команды приведены для последней опубликованной версии API.

Доступность функционала зависит от типа редакции Termidesk.
Таблица 2. Перечень URL-команд модуля «aggregator», связанных с доменами аутентификации
URL-команда Тип Описание

/api/aggregator/v7.0/authenticators

GET

Возвращает список доменов аутентификации

/api/aggregator/v7.0/authenticators/{small_name}

GET

Возвращает домен аутентификации, имеющего короткое наименование {small_name}

/api/aggregator/v7.0/authenticators/{small_name}/permissions

GET

Возвращает список разрешений для пользователя домена аутентификации {small_name}

/api/aggregator/v7.0/authenticators/{small_name}/services

GET

Возвращает список фондов, ассоциированных с доменом аутентификации, имеющего короткое наименование {small_name}

Команды, связанные со списками сертификатов

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «aggregator», связанных с сертификатами). Команды приведены для последней опубликованной версии API.

Таблица 3. Перечень URL-команд модуля «aggregator», связанных с сертификатами
URL-команда Тип Описание

/api/aggregator/v7.0/certificates

GET

Получение списка сертификатов

/api/aggregator/v7.0/certificates/{id}

GET

Получение сертификата с идентификатором {id}

Команды, связанные с предоставлением ресурсов

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «aggregator», связанных с получением ресурсов). Команды приведены для последней опубликованной версии API.

Таблица 4. Перечень URL-команд модуля «aggregator», связанных с получением ресурсов
URL-команда Тип Описание

/api/aggregator/v7.0/enable/{service}/{transport}

GET

API для работы с TicketStore

Команды, связанные с проверкой состояния

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «aggregator», связанных с проверкой состояния). Команды приведены для последней опубликованной версии API.

Таблица 5. Перечень URL-команд модуля «aggregator», связанных с проверкой состояния
URL-команда Тип Описание

/api/aggregator/v7.0/health_check

GET

Проверка состояния портала «Агрегатор»

Доступные команды модуля «auth»

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «auth»).

Таблица 6. Перечень URL-команд модуля «auth»
URL-команда Тип Описание

/api/auth/v7.0/authenticators

GET

Получение списка аутентификаторов

/api/auth/v7.0/authenticators/{auth_uuid}/pkinit/finalize

PATCH

Завершение аутентификации Kerberos PKINIT

/api/auth/v7.0/authenticators/{auth_uuid}/pkinit/login

PATCH

Инициализация аутентификации Kerberos PKINIT и получение данных на подпись

/api/auth/v7.0/authenticators/{auth_uuid}/pkinit/raw

PATCH

Прямой запрос на сервер Kerberos PKINIT с подписанным сертификатом

/api/auth/v7.0/jwtauth

POST

Авторизация «Агрегатора» на «Универсальном диспетчере». В ответ на подписанный «Агрегатором» токен «Универсальный диспетчер» возвращает сеансовый ключ (токен)

/api/auth/v7.0/legacy/login

POST

Аутентификация пользователя на базе аутентификатора, логина и пароля.

При отправке запроса необходимо обязательно указать один из параметров:

  • «authId»;

  • «auth»;

  • «authSmallName»

/api/auth/v7.0/legacy/login/2fa

POST

Двухфакторная аутентификация пользователя на базе аутентификатора, логина и пароля.

При отправке запроса необходимо обязательно указать один из параметров:

  • «authId»;

  • «auth»;

  • «authSmallName»

/api/auth/v7.0/legacy/logout

POST

Прекращение действие токена/сессии пользователя.

Токен аутентификации должен передаваться в заголовке X-Auth-Token

/api/auth/v7.0/settings

GET

Получение глобальных настроек сервера

Доступные команды модуля «client»

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «client»).

Таблица 7. Перечень URL-команд модуля «client»
URL-команда Тип Описание

/api/client/v7.0/component_info/{uuid}

PATCH

API для получения дополнительной информации о подключении пользователя

/api/client/v7.0/connectionInfo/{uuid}

GET

API для выдачи параметров подключения компоненту «Клиент» для протоколов RDP и SPICE

/api/client/v7.0/enable/{service}/{transport}

GET

API для работы с TicketStore

/api/client/v7.0/enable_async

POST

API для создания задачи проверки статуса РМ по запросу компонента «Клиент»

/api/client/v7.0/enable_async/{uuid}

GET

API для выдачи информации о состоянии задачи проверки статуса РМ компоненту «Клиент»

/api/client/v7.0/images/srvimg/{image_id}

GET

API для выдачи изображения по идентификатору, либо для протокола доставки, либо установленное по умолчанию

/api/client/v7.0/images/transicon/{image_id}

GET

API для выдачи изображения по идентификатору для протокола доставки

/api/client/v7.0/preconnectionInfo/{uuid}

GET

API для выдачи параметров подключения компоненту «Клиент». Компонент «Клиент» использует метод для проверки готовности сервиса к подключению и уточнения используемого протокола. По полученным данным принимает решение: завершить неудачное подключение, подождать и повторить, подключаться новым/старым методом

/api/client/v7.0/reconnect

POST

Обновляет ссылку для переподключения к сессии РМ

/api/client/v7.0/service/{uuid}/machine_state

PATCH

Перезагружает РМ

/api/client/v7.0/servicesList

GET

Получение списка доступных фондов

/api/client/v7.0/weblink/{id_service}/{id_transport}

GET

Возвращает параметры подключения к РМ по конкретному протоколу доставки

/api/client/v7.0/workplaces

GET

Получение списка назначенных РМ

Доступные команды модуля «discover»

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «discover»).

Таблица 8. Перечень URL-команд модуля «discover»
URL-команда Тип Описание

/api/discover/

GET

Возвращает список модулей API, предоставляемых компонентом «Универсальный диспетчер»

Доступные команды модуля «health»

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «health»).

Таблица 9. Перечень URL-команд модуля «health»
URL-команда Тип Описание

/api/health/check

GET

Проверка состояния сервера. Собираются общие показатели и набор числовых метрик.

Для авторизации при обращении к запросу используется токен, определенный в параметре HEALTH_CHECK_ACCESS_KEY конфигурационного файла /etc/opt/termidesk-vdi/termidesk.conf.

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

Для разных конфигураций системы один и тот же показатель в абсолютном выражении может соответствовать состоянию и «PASS», и «FAIL».

Формат запроса:

curl --insecure -v -s -X 'GET' \
  'https://$\{hostname}:$\{health_port}/api/health/check' \
  -H 'accept: application/json' \
  -H 'Authorization: Token $\{health_check_access_key}'

где:

--insecure - отключение проверки валидности сертификатов. Выполнение запроса без использования проверки SSL допустимо только на тестовых стендах. В производственной среде необходимо установить валидные сертификаты;

${hostname} - сетевой адрес или полное доменное имя узла;

${health_port} - порт для запросов проверки состояния. По умолчанию используется порт веб-сервера, 443;

${health_check_access_key} - токен, определенный в параметре HEALTH_CHECK_ACCESS_KEY файла /etc/opt/termidesk-vdi/termidesk.conf

/api/health/metrics

GET
Доступность функционала зависит от типа редакции Termidesk.

Возвращает список метрик сервера. Для авторизации при обращении к запросу используется токен, определенный в параметре METRICS_ACCESS_KEY конфигурационного файла /etc/opt/termidesk-vdi/termidesk.conf.

Формат запроса:

curl --insecure -v -s -X 'GET' \
  'https://$\{hostname}:$\{health_port}/api/health/metrics' \
  -H 'accept: application/json' \
  -H 'Authorization: Token $\{metrics_access_key}'

где:

--insecure - отключение проверки валидности сертификатов. Выполнение запроса без использования проверки SSL допустимо только на тестовых стендах. В производственной среде необходимо установить валидные сертификаты;

${hostname} - сетевой адрес или полное доменное имя узла;

${health_port} - порт для запросов проверки состояния. По умолчанию используется порт веб-сервера, 443;

${metrics_access_key} - токен, определенный в переменной METRICS_ACCESS_KEY файла /etc/opt/termidesk-vdi/termidesk.conf.

Информацию по всем возвращаемым значениям можно получить в документации библиотеки psutil на сайте: https://psutil.readthedocs.io/en/latest.

Вид возвращаемого списка метрик приведен после таблицы

Вид возвращаемого списка метрик:

# Версия компонента
version_info{version="5.1-dev-HEAD-20240614064304-c1d6651db"} 1.0
# Версия ОС
system_info{machine="x86_64",os="Linux 5.10.190-1-hardened",version="#astra1+ci6 SMP Fri Oct 6 14:47:06 UTC 2023"} 1.0
# Период в секундах, в течение которого система функционирует без проблем
uptime_seconds 66686.97834658623
# Общая загрузка процессора в процентах
cpu_total_percent 4.8
# Общее использование физической памяти в процентах
virtual_memory_total_percent 40.5
# Количество операций чтения с диска
disk_read_count 68201.0
# Количество операций записи на диск
disk_write_count 729848.0
# Число прочитанных с диска байт
disk_read_bytes 2.094142464e+09
# Число записанных на диск байт
disk_write_bytes 7.54249728e+09
# Общий размер физической памяти в байтах
virtual_memory_total_bytes 4.117311488e+09
# Размер доступной физической памяти в байтах
virtual_memory_available_bytes 2.447736832e+09
# Размер используемой физической памяти в байтах
virtual_memory_used_bytes 1.303724032e+09
# Размер свободной физической памяти в байтах
virtual_memory_free_bytes 3.78679296e+08
# Общий размер диска в байтах
disk_total_bytes 1.5742214144e+010
# Используемый размер диска в байтах
disk_used_bytes 1.4512279552e+010
# Свободный размер диска в байтах
disk_free_bytes 4.07957504e+08
# Количество авторизованных пользователей в портале пользователя
user_session_count 1.0
# Количество авторизованных администраторов в портале администратора
admin_session_count 17.0
# Количество сеансов пользователей РМ
VM_users_sessions{type="in_use"} 1.0
VM_users_sessions{type="vacant"} 4.0
# Количество сеансов пользователей терминальных сессий
RDS_STAL_users_sessions{type="in_use"} 1.0
RDS_STAL_users_sessions{type="vacant"} 0.0
# Общее количество виртуальных машин
total_vms 48.0
# Количество виртуальных машин с ошибкой запуска
failed_to_start_vms 38.0
# Количество зависших виртуальных машин
stuck_vms 0.0
# Количество незарегистрированных на «Универсальном диспетчере» «Агентов»
unregistered_agents 41.0

Доступные команды модуля «ssa»

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «ssa»).

Таблица 10. Перечень URL-команд модуля «ssa»
URL-команда Тип Описание

/api/ssa/v7.0/event

POST

Регистрация событий от «Сессионного агента»

/api/ssa/v7.0/settings

GET

Получение настроек компонента «Ретранслятор»

Доступные команды модуля «userinfo»

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «userinfo»).

Таблица 11. Перечень URL-команд модуля «userinfo»
URL-команда Тип Описание

/api/userinfo/themes

GET

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

/api/userinfo/themes

PUT

Обновление параметров брендирования

/api/userinfo/

GET

Получение информации о пользователе

Доступные команды модуля «webui»

Команды, связанные со списками устройств доступа

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных со списками устройств доступа).

Версия API /api/webui/draft/ будет удалена в следующем релизе.

Опубликована новая версия API /api/webui/server.
Таблица 12. Перечень URL-команд, связанных со списками устройств доступа
URL-команда Тип Описание

/api/webui/server/access-devices

GET

Возвращает список устройств доступа

/api/webui/server/access-devices/{uuid}

GET

Возвращает устройство доступа с идентификатором {uuid}

/api/webui/server/access-devices/{uuid}/{status}

PATCH

Изменяет статус устройства доступа с идентификатором {uuid}

Команды, связанные со списками доступа

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных со списками доступа).

Таблица 13. Перечень URL-команд, связанных со списками доступа
URL-команда Тип Описание

/api/webui/server/acl

GET

Возвращает список объектных разрешений

/api/webui/server/acl/{group_pk}/{data_type}/{object_pk}

GET

Возвращает набор операций для управления объектными разрешениями

/api/webui/server/acl/{group_pk}/{data_type}/{object_pk}

POST

Обновляет набор операций для управления объектными разрешениями

/api/webui/server/acl/{group_pk}/{data_type}/{object_pk}

PUT

Обновляет набор операций для управления объектными разрешениями

/api/webui/server/acl/{group_pk}/{data_type}/{object_pk}

DELETE

Удаляет объектное разрешение

/api/webui/server/acl/export

GET

Формирует файл экспорта объектных разрешений

/api/webui/server/acl/export

POST

Получает файл экспорта объектных разрешений

/api/webui/server/acl/gui/{data_type}

GET

Возвращает описание для графического интерфейса

/api/webui/server/acl/permissions/{data_type}

GET

Возвращает список разрешений для переданного типа объекта

/api/webui/server/acl/types

GET

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

Команды, связанные с объектами инфраструктуры

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с объектами инфраструктуры).

Таблица 14. Перечень URL-команд, связанных с объектами инфраструктуры
URL-команда Тип Описание

/api/webui/server/appnodes/brokers

GET

Возвращает список объектов инфраструктуры («Универсальных диспетчеров»)

/api/webui/server/appnodes/brokers/{broker_uuid}/certificate/gui

GET

Управляет сертификатами объекта («Универсальный диспетчер»)

/api/webui/server/appnodes/brokers/{broker_uuid}/certificate/set

PATCH

Обновляет сертификаты объекта («Универсальный диспетчер»)

/api/webui/server/appnodes/brokers/{uuid}

DELETE

Удаляет объект инфраструктуры («Универсальный диспетчер») с идентификатором {uuid}

/api/webui/server/appnodes/brokers/{uuid}/metrics

GET

Возвращает список метрик объектов инфраструктуры («Универсальных диспетчеров»)

/api/webui/server/appnodes/brokers/{uuid}/tags

GET

Возвращает список тегов объектов инфраструктуры («Универсальных диспетчеров»)

/api/webui/server/appnodes/brokers/export

GET

Формирует файл экспорта объектов инфраструктуры («Универсальных диспетчеров»)

/api/webui/server/appnodes/brokers/export

POST

Получает файл экспорта объектов инфраструктуры («Универсальных диспетчеров»)

/api/webui/server/appnodes/gateways

GET

Возвращает список объектов инфраструктуры («Шлюзов»)

/api/webui/server/appnodes/gateways/{broker_uuid}/certificate/gui

GET

Управляет сертификатами объекта («Шлюз»)

/api/webui/server/appnodes/gateways/{broker_uuid}/certificate/set

PATCH

Обновляет сертификаты объекта («Шлюз»)

/api/webui/server/appnodes/gateways/{uuid}

DELETE

Удаляет объект инфраструктуры («Шлюз») с идентификатором {uuid}

/api/webui/server/appnodes/gateways/{uuid}/metrics

PATCH

Возвращает список метрик объектов инфраструктуры («Шлюзов»)

/api/webui/server/appnodes/gateways/{uuid}/tags

PATCH

Возвращает список тегов объектов инфраструктуры («Шлюзов»)

/api/webui/server/appnodes/gateways/export

GET

Формирует файл экспорта объектов инфраструктуры («Шлюзов»)

/api/webui/server/appnodes/gateways/export

POST

Получает файл экспорта объектов инфраструктуры («Шлюзов»)

/api/webui/server/appnodes/journal_storages

GET

Возвращает список объектов инфраструктуры («Хранилищ журналов»)

/api/webui/server/appnodes/journal_storages

POST

Обновляет список объектов инфраструктуры («Хранилищ журналов»)

/api/webui/server/appnodes/journal_storages/{uuid}

GET

Возвращает объект инфраструктуры («Хранилище журналов») с идентификатором {uuid}

/api/webui/server/appnodes/journal_storages/{uuid}

PUT

Обновляет объект инфраструктуры («Хранилище журналов») с идентификатором {uuid}

/api/webui/server/appnodes/journal_storages/{uuid}

DELETE

Удаляет объект инфраструктуры («Хранилище журналов») с идентификатором {uuid}

/api/webui/server/appnodes/journal_storages/{uuid}/activation

PATCH

Меняет состояние объекта инфраструктуры («Хранилища журналов») с идентификатором {uuid}

/api/webui/server/appnodes/journal_storages/export

GET

Формирует файл экспорта объектов инфраструктуры («Хранилищ журналов»)

/api/webui/server/appnodes/journal_storages/export

POST

Получает файл экспорта объектов инфраструктуры («Хранилищ журналов»)

/api/webui/server/appnodes/journal_storages/gui

GET

Возвращает описание для графического интерфейса для объектов инфраструктуры («Хранилищ журналов»)

/api/webui/server/appnodes/portals

GET

Возвращает список объектов инфраструктуры («Порталов»)

/api/webui/server/appnodes/portals/{broker_uuid}/certificate/gui

GET

Управляет сертификатами объекта («Порталов»)

/api/webui/server/appnodes/portals/{broker_uuid}/certificate/set

PATCH

Обновляет сертификаты объекта («Порталов»)

/api/webui/server/appnodes/portals/{uuid}

DELETE

Удаляет объект инфраструктуры («Портал») с идентификатором {uuid}

/api/webui/server/appnodes/portals/{uuid}/metrics

PATCH

Возвращает список метрик объектов инфраструктуры («Порталов»)

/api/webui/server/appnodes/portals/{uuid}/tags

PATCH

Возвращает список тегов объектов инфраструктуры («Порталов»)

/api/webui/server/appnodes/portals/export

GET

Формирует файл экспорта объектов инфраструктуры («Порталов»)

/api/webui/server/appnodes/portals/export

POST

Получает файл экспорта объектов инфраструктуры («Порталов»)

/api/webui/server/appnodes/repeaters

GET

Возвращает список объектов инфраструктуры («Ретрансляторов»)

/api/webui/server/appnodes/repeaters

POST

Обновляет список объектов инфраструктуры («Ретрансляторов»)

/api/webui/server/appnodes/repeaters/{uuid}

GET

Возвращает объект инфраструктуры («Ретранслятор») с идентификатором {uuid}

/api/webui/server/appnodes/repeaters/{uuid}

PUT

Обновляет объект инфраструктуры («Ретранслятор») с идентификатором {uuid}

/api/webui/server/appnodes/repeaters/{uuid}

DELETE

Удаляет объект инфраструктуры («Ретранслятор») с идентификатором {uuid}

/api/webui/server/appnodes/repeaters/{uuid}/activation

PATCH

Меняет состояние объекта инфраструктуры («Ретранслятора») с идентификатором {uuid}

/api/webui/server/appnodes/repeaters/export

GET

Формирует файл экспорта объектов инфраструктуры («Ретрансляторов»)

/api/webui/server/appnodes/repeaters/export

POST

Получает файл экспорта объектов инфраструктуры («Ретрансляторов»)

/api/webui/server/appnodes/repeaters/gui

GET

Возвращает описание для графического интерфейса для объектов инфраструктуры («Ретрансляторов»)

/api/webui/server/appnodes/vmcontrollers

GET

Возвращает список объектов инфраструктуры («Менеджеров рабочих мест»)

/api/webui/server/appnodes/vmcontrollers/{broker_uuid}/certificate/gui

GET

Управляет сертификатами объекта («Менеджер рабочих мест»)

/api/webui/server/appnodes/vmcontrollers/{broker_uuid}/certificate/set

PATCH

Обновляет сертификаты объекта («Менеджер рабочих мест»)

/api/webui/server/appnodes/vmcontrollers/{uuid}

DELETE

Удаляет объект инфраструктуры («Менеджер рабочих мест») с идентификатором {uuid}

/api/webui/server/appnodes/vmcontrollers/{uuid}/metrics

GET

Возвращает список метрик объектов инфраструктуры («Менеджеров рабочих мест»)

/api/webui/server/appnodes/vmcontrollers/{uuid}/tags

GET

Возвращает список тегов объектов инфраструктуры («Менеджеров рабочих мест»)

/api/webui/server/appnodes/vmcontrollers/export

GET

Формирует файл экспорта объектов инфраструктуры («Менеджеров рабочих мест»)

/api/webui/server/appnodes/vmcontrollers/export

POST

Получает файл экспорта объектов инфраструктуры («Менеджеров рабочих мест»)

Команды, связанные с журналами событий

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с журналами событий).

Таблица 15. Перечень URL-команд, связанных с журналами событий
URL-команда Тип Описание

/api/webui/server/audit/events

GET

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

/api/webui/server/audit/events/export

GET

Формирует файл экспорта событий журнала

/api/webui/server/audit/events/export

POST

Получает файл экспорта событий журнала

/api/webui/server/audit/events/types

GET

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

Команды, связанные с доменами аутентификации

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с доменами аутентификации).

Таблица 16. Перечень URL-команд, связанных с доменами аутентификации
URL-команда Тип Описание

/api/webui/server/authenticators

GET

Возвращает список доменов аутентификации

/api/webui/server/authenticators

POST

Создает домен аутентификации

/api/webui/server/authenticators/{auth_uuid}/groups

GET

Возвращает список групп домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/groups

POST

Создает группу домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/groups/{group_uuid}/policies

GET

Возвращает список политик группы

/api/webui/server/authenticators/{auth_uuid}/groups/{group_uuid}/policies

POST

Создает политику группы

/api/webui/server/authenticators/{auth_uuid}/groups/{group_uuid}/policies/{uuid}

GET

Возвращает политику группы

/api/webui/server/authenticators/{auth_uuid}/groups/{group_uuid}/policies/{uuid}

PUT

Изменяет значение политики группы

/api/webui/server/authenticators/{auth_uuid}/groups/{group_uuid}/policies/{uuid}

DELETE

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

/api/webui/server/authenticators/{auth_uuid}/groups/{group_uuid}/policies/gui/{policy_type}

GET

Возвращает описание для графического интерфейса политики с типом {policy_type}

/api/webui/server/authenticators/{auth_uuid}/groups/{uuid}

GET

Возвращает группу с идентификатором {uuid} домена аутентификации с идентификатором {auth_uuid}

/api/webui/server/authenticators/{auth_uuid}/groups/{uuid}

PUT

Обновляет группу домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/groups/{uuid}

DELETE

Удаляет группу домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/groups/{uuid}/servicesPools

GET

Возвращает список РМ группы домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/groups/{uuid}/users

GET

Возвращает список пользователей группы домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/groups/external

GET

Возвращает список доступных групп для домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/groups/gui/{group_type}

GET

Возвращает описание для графического интерфейса группы с типом {group_type}

/api/webui/server/authenticators/{auth_uuid}/groups/types

GET

Возвращает список доступных типов групп домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/log

GET

Возвращает журнал домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users

GET

Возвращает список пользователей домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users

POST

Создает пользователя домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/{uuid}

GET

Возвращает пользователя с идентификатором {uuid} домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/{uuid}

PUT

Обновляет пользователя домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/{uuid}

DELETE

Удаляет пользователя домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/{uuid}/log

GET

Возвращает журнал пользователя домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/{uuid}/servicesPools

GET

Возвращает список РМ пользователя домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/{uuid}/userServices

GET

Возвращает список ассоциированных виртуальных машин (ВМ) для пользователя домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/bulk_destroy

PATCH

Удаляет пользователей домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/bulk_update

PATCH

Обновляет пользователей домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/external

GET

Возвращает список доступных пользователей для домена аутентификации

/api/webui/server/authenticators/{auth_uuid}/users/gui

GET

Возвращает описание для графического интерфейса

/api/webui/server/authenticators/{auth_uuid}/users/types

GET

Возвращает список доступных типов пользователей домена аутентификации

/api/webui/server/authenticators/{uuid}

GET

Возвращает домен аутентификации

/api/webui/server/authenticators/{uuid}

PUT

Обновляет домен аутентификации

/api/webui/server/authenticators/{uuid}

DELETE

Удаляет домен аутентификации

/api/webui/server/authenticators/{uuid}/attribute

PATCH

Добавить, изменить или удалить атрибут домена для сохранения в учетной записи пользователя

/api/webui/server/authenticators/gui/{data_type}

GET

Возвращает описание для графического интерфейса домена аутентификации с типом {data_type}

/api/webui/draft/authenticators/test/{type}

POST

Тестирует параметры домена аутентификации

/api/webui/draft/authenticators/types

GET

Возвращает список доступных типов доменов аутентификации

Команды, связанные с панелью мониторинга

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с панелью мониторинга).

Таблица 17. Перечень URL-команд, связанных с панелью мониторинга
URL-команда Тип Описание

/api/webui/server/dashboard

GET

Возвращает список объектов панели мониторинга

/api/webui/server/dashboard/admin

GET

Возвращает список объектов панели мониторинга для «Портала администратора»

/api/webui/server/dashboard/user

GET

Возвращает список объектов панели мониторинга для «Портала пользователя»

Команды, связанные с изображениями гостевых ОС

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с изображением гостевых ОС).

Таблица 18. Перечень URL-команд, связанных с изображением гостевых ОС
URL-команда Тип Описание

/api/webui/server/gallery/images

GET

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

/api/webui/server/gallery/images

POST

Создает изображение

/api/webui/server/gallery/images/{uuid}

GET

Возвращает изображение с идентификатором {uuid}

/api/webui/server/gallery/images/{uuid}

PUT

Обновляет изображение

/api/webui/server/gallery/images/{uuid}

DELETE

Удаляет изображение

/api/webui/server/gallery/images/gui

GET

Возвращает описание для графического интерфейса

/api/webui/server/gallery/images/srvimg/{image_id}

GET

Возвращает изображение по идентификатору, либо для протокола доставки, либо установленное по умолчанию

/api/webui/server/gallery/images/transicon/{image_id}

GET

Возвращает изображение для протокола доставки

Команды, связанные с профилями шлюзов

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с профилями шлюзов).

Таблица 19. Перечень URL-команд, связанных с профилями шлюзов
URL-команда Тип Описание

/api/webui/server/gateways

GET

Возвращает список профилей шлюзов

/api/webui/server/gateways

POST

Создает профиль шлюза

/api/webui/server/gateways/{uuid}

GET

Возвращает профиль шлюза

/api/webui/server/gateways/{uuid}

PUT

Обновляет профиль шлюза

/api/webui/server/gateways/{uuid}

DELETE

Удаляет профиль шлюза

/api/webui/server/gateways/gui/{gateway_type}

GET

Возвращает описание для графического интерфейса профиля шлюза с типом {gateway_type}

/api/webui/server/gateways/test/{gateway_type}

POST

Тестирует параметры профиля шлюза

/api/webui/server/gateways/types

GET

Возвращает список типов профилей шлюзов

Команды, связанные с графическим интерфейсом

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с вызовом функций графического интерфейса).

Таблица 20. Перечень URL-команд, связанных с вызовом функций графического интерфейса
URL-команда Тип Описание

/api/webui/server/gui/callback/{callback}

GET

Предоставляет доступ к callback-функциям графического интерфейса

Команды, связанные с получением индекса

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с получением индекса).

Таблица 21. Перечень URL-команд, связанных с получением индекса
URL-команда Тип Описание

/api/webui/server

GET

Определяет текущую версию REST API

Команды, связанные с лицензией

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с лицензией).

Таблица 22. Перечень URL-команд, связанных с лицензией
URL-команда Тип Описание

/api/webui/server/license

POST

Загружает новую лицензию

/api/webui/server/license/brokers

GET

Возвращает список идентификаторов узлов фермы Termidesk (зарегистрированных в разделе «Инфраструктура»), для которых нужна лицензия.

Список узлов в лицензии и по этой URL-команде будет различаться, если произошло изменение в составе узлов, а лицензия не была обновлена

/api/webui/server/license/history

GET

Генерирует и возвращает отчет об использованных лицензиях в данной инсталляции

/api/webui/server/license/info

GET

Получает информацию о лицензии

/api/webui/server/license/remove

DELETE

Удаляет лицензию

/api/webui/server/license/stats/licensed_connections/{interval}

GET

Возвращает статистику лицензируемых подключений по:

  • часам за последние 7 дней с учетом часового пояса сервера;

  • дням за последние 365 дней с учетом часового пояса сервера;

  • месяцам за весь период работы сервера

api/webui/server/license/stats/licensed_users/{interval}

GET

Возвращает статистику лицензируемых пользователей по:

* часам за последние 7 дней с учетом часового пояса сервера; * дням за последние 365 дней с учетом часового пояса сервера; * месяцам за весь период работы сервера

Команды, связанные с отображением журнала

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с отображением журнала).

Таблица 23. Перечень URL-команд, связанных с отображением журнала
URL-команда Тип Описание

/api/webui/server/logs/journal

GET

Возвращает централизованный журнал

/api/webui/server/logs/journal/export

GET

Формирует файл экспорта событий журнала

Команды, связанные с функциями мониторинга

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с функциями мониторинга).

Таблица 24. Перечень URL-команд, связанных с функциями мониторинга
URL-команда Тип Описание

/api/webui/server/monitoring

GET

Возвращает все журналы в виде списка

/api/webui/server/monitoring/export

GET

Формирует файл экспорта событий журнала

/api/webui/server/monitoring/export

POST

Получает файл экспорта событий журнала

Команды, связанные с аутентификацией на основе адресов сети

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с IP-аутентификацией).

Таблица 25. Перечень URL-команд, связанных с IP-аутентификацией
URL-команда Тип Описание

/api/webui/server/networks

GET

Возвращает список сетей

/api/webui/server/networks

POST

Создает сеть

/api/webui/server/networks/{network_uuid}/policies

GET

Возвращает список политик сети

/api/webui/server/networks/{network_uuid}/policies

POST

Создает политику сети

/api/webui/server/networks/{network_uuid}/policies/{uuid}

GET

Возвращает политику сети

/api/webui/server/networks/{network_uuid}/policies/{uuid}

PUT

Изменяет значение политики сети

/api/webui/server/networks/{network_uuid}/policies/{uuid}

DELETE

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

/api/webui/server/networks/{network_uuid}/policies/gui/{policy_type}

GET

Возвращает описание для графического интерфейса политики сети с типом {policy_type}

/api/webui/server/networks/{uuid}

GET

Возвращает сеть с идентификатором {uuid}

/api/webui/server/networks/{uuid}

PUT

Обновляет сеть

/api/webui/server/networks/{uuid}

DELETE

Удаляет сеть

/api/webui/server/networks/gui

GET

Возвращает описание для графического интерфейса сети

Команды, связанные с параметрами гостевых ОС

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с параметрами гостевых ОС).

Таблица 26. Перечень URL-команд, связанных с параметрами гостевых ОС
URL-команда Тип Описание

/api/webui/server/osmanagers

GET

Возвращает список параметров гостевых ОС

/api/webui/server/osmanagers

POST

Создает параметры гостевых ОС

/api/webui/server/osmanagers/{uuid}

GET

Возвращает параметры гостевых ОС с идентификатором {uuid}

/api/webui/server/osmanagers/{uuid}

PUT

Обновляет параметры гостевых ОС

/api/webui/server/osmanagers/{uuid}

DELETE

Удаляет параметры гостевых ОС

/api/webui/server/osmanagers/gui/{data_type}

GET

Возвращает описание для графического интерфейса для параметров с типом {data_type}

/api/webui/server/osmanagers/types

GET

Возвращает список типов параметров гостевых ОС

Команды, связанные с глобальными политиками

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с глобальными политиками).

Таблица 27. Перечень URL-команд, связанных с глобальными политиками
URL-команда Тип Описание

/api/webui/server/policies

GET

Список всех доступных политик

/api/webui/server/policies

POST

Управляет глобальными политиками

/api/webui/server/policies/{uuid}

GET

Получает информацию о политике с идентификатором {uuid}

/api/webui/server/policies/{uuid}

PUT

Меняет значение политики с идентификатором {uuid}

/api/webui/server/policies/{uuid}

DELETE

Сбрасывает значение глобальной политики с идентификатором {uuid}

/api/webui/server/policies/export

GET

Формирует файл экспорта политик

/api/webui/server/policies/export

POST

Получает файл экспорта политик

/api/webui/server/policies/gui/{policy_type}

GET

Возвращает спецификацию полей графического интерфейса для политики конкретного типа

Команды, связанные с поставщиками ресурсов

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с поставщиками ресурсов).

Таблица 28. Перечень URL-команд, связанных с поставщиками ресурсов
URL-команда Тип Описание

/api/webui/server/providers

GET

Возвращает список поставщиков ресурсов

/api/webui/server/providers

POST

Создает поставщика ресурсов

/api/webui/server/providers/{provider_uuid}/services

GET

Возвращает список шаблонов РМ поставщика ресурсов

/api/webui/server/providers/{provider_uuid}/services

POST

Создает шаблон РМ

/api/webui/server/providers/{provider_uuid}/services/{uuid}

GET

Возвращает шаблон РМ с идентификатором {uuid} поставщика ресурсов

/api/webui/server/providers/{provider_uuid}/services/{uuid}

PUT

Обновляет шаблон РМ с идентификатором {uuid} поставщика ресурсов

/api/webui/server/providers/{provider_uuid}/services/{uuid}

DELETE

Удаляет шаблон РМ с идентификатором {uuid} поставщика ресурсов

/api/webui/server/providers/{provider_uuid}/services/export

GET

Формирует файл экспорта шаблонов поставщика ресурсов

/api/webui/server/providers/{provider_uuid}/services/export

POST

Получает файл экспорта шаблонов поставщика ресурсов

/api/webui/server/providers/{provider_uuid}/services/gui/{service_type}

GET

Возвращает описание для графического интерфейса для шаблона РМ с типом {service_type} поставщика ресурсов

/api/webui/server/providers/{provider_uuid}/services/snapshot

POST

Создает снимок ВМ (снапшот)

/api/webui/server/providers/{provider_uuid}/services/types

GET

Возвращает список доступных типов шаблонов РМ поставщика ресурсов

/api/webui/server/providers/{uuid}

GET

Возвращает поставщика ресурсов с идентификатором {uuid}

/api/webui/server/providers/{uuid}

PUT

Обновляет поставщика ресурсов

/api/webui/server/providers/{uuid}

DELETE

Удаляет поставщика ресурсов

/api/webui/server/providers/{uuid}/maintenance

PATCH

Переводит поставщика ресурсов в режим техобсуживания

/api/webui/server/providers/export

GET

Формирует файл экспорта поставщиков ресурсов

/api/webui/server/providers/export

POST

Получает файл экспорта поставщиков ресурсов

/api/webui/server/providers/gui/{prov_type}

GET

Возвращает описание для графического интерфейса

/api/webui/server/providers/test/{prov_type}

POST

Тестирует параметры поставщика ресурсов

/api/webui/server/providers/types

GET

Возвращает список доступных типов поставщиков техобслуживания

Команды, связанные с управлением полномочиями (ролями)

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с управлением ролями).

Таблица 29. Перечень URL-команд, связанных с управлением ролями
URL-команда Тип Описание

/api/webui/server/rbac

GET

Возвращает список ролей

/api/webui/server/rbac

POST

Создает роль

/api/webui/server/rbac/{id}

GET

Возвращает роль

/api/webui/server/rbac/{id}

PUT

Обновляет роль

/api/webui/server/rbac/{id}

DELETE

Удаляет роль

/api/webui/server/rbac/gui

GET

Возвращает описание для графического интерфейса

/api/webui/server/rbac/permissions

GET

Возвращает список разрешений для ролей

Команды, связанные с отчетами

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с отчетами).

Таблица 30. Перечень URL-команд, связанных с отчетами
URL-команда Тип Описание

/api/webui/server/reports

GET

Возвращает список отчетов

/api/webui/server/reports

POST

Создает отчет

/api/webui/server/reports/{id}

GET

Возвращает отчет с идентификатором {id}

/api/webui/server/reports/{id}

PUT

Обновляет отчет с идентификатором {id}

/api/webui/server/reports/{id}

DELETE

Удаляет отчет с идентификатором {id}

/api/webui/server/reports/{id}/generate

GET

Генерирует отчет с идентификатором {id}

/api/webui/server/reports/{id}/generate/export

GET

Формирует файл экспорта отчета с идентификатором {id}

/api/webui/server/reports/{id}/generate/export

POST

Получает файл экспорта отчета с идентификатором {id}

/api/webui/server/reports/gui/{data_type}

GET

Возвращает описание для графического интерфейса

/api/webui/server/reports/types

GET

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

Команды, связанные с расписаниями

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с расписаниями).

Таблица 31. Перечень URL-команд, связанных с расписаниями
URL-команда Тип Описание

/api/webui/server/scheduler

GET

Возвращает список расписаний

/api/webui/server/scheduler

POST

Создает расписание

/api/webui/server/scheduler/{id}

GET

Возвращает расписание с идентификатором {id}

/api/webui/server/scheduler/{id}

PUT

Обновляет расписание с идентификатором {id}

/api/webui/server/scheduler/{id}

DELETE

Удаляет расписание с идентификатором {id}

/api/webui/server/scheduler/{id}/activation

PATCH

Меняет состояние расписания с идентификатором {id}

Команды, связанные со скриптами

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных со скриптами).

Таблица 32. Перечень URL-команд, связанных со скриптами
URL-команда Тип Описание

/api/webui/server/script

GET

Возвращает список скриптов

/api/webui/server/script

POST

Создает скрипт

/api/webui/server/script/{uuid}

GET

Возвращает скрипт

/api/webui/server/script/{uuid}

PUT

Обновляет скрипт

/api/webui/server/script/{uuid}

DELETE

Удаляет скрипт

Команды, связанные с фондами РМ

Доступные администратору URL-команды перечислены в таблице (см. таблицу [ереченьURLкомандсвязанныхсфондамиРМ]).

Таблица 33. Перечень URL-команд, связанных с фондами РМ
URL-команда Тип Описание

/api/webui/server/servicespools

GET

Возвращает список фондов РМ

/api/webui/server/servicespools

POST

Создает фонд РМ

/api/webui/server/servicespools/{servicespool_uuid}/cache

GET

Получение списка РМ, находящихся в кеше фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}

GET

Возвращает РМ, находящееся в кеше фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}

DELETE

Удаляет РМ, находящееся в кеше из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}/assign

PATCH

Назначает пользователю РМ, находящееся в кеше

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}/assign/gui

GET

Возвращает описание для графического интерфейса РМ, находящегося в кеше

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}/execute_script

PATCH

Выполняет скрипт для РМ, находящегося в кеше

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}/log

GET

Возвращает журнал РМ, находящегося в кеше

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}/machine

PATCH

Управляет состоянием питания выбранного РМ, находящегося в кеше

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}/maintenance

PATCH

Управляет режимом техобслуживания РМ, находящегося в кеше

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}/metrics

GET

Возвращает список метрик РМ, находящегося в кеше

/api/webui/server/servicespools/{servicespool_uuid}/cache/{uuid}/refresh

PATCH

Управляет кешированными РМ из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/groups

GET

Возвращает список групп фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/groups

POST

Добавляет группу в фонд РМ

/api/webui/server/servicespools/{servicespool_uuid}/groups/{uuid}

DELETE

Удаляет группу с идентификатором {uuid} из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/groups/gui

GET

Возвращает описание для графического интерфейса

/api/webui/server/servicespools/{servicespool_uuid}/networks

GET

Возвращает список сетей из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/networks

POST

Добавляет сеть в фонд РМ

/api/webui/server/servicespools/{servicespool_uuid}/networks/{uuid}

DELETE

Удаляет сеть с идентификатором {uuid} из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/networks/gui

GET

Возвращает описание для графического интерфейса

/api/webui/server/servicespools/{servicespool_uuid}/policies

GET

Возвращает список всех политик фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/policies

POST

Обновляет политику фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/policies/{uuid}

GET

Получает информацию о политике фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/policies/{uuid}

PUT

Обновляет параметры политики фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/policies/{uuid}

DELETE

Сбрасывает политику фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/policies/export

GET

Формирует файл экспорта политик фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/policies/export

POST

Получает файл экспорта политик фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/policies/gui/{policy_type}

GET

Возвращает спецификацию полей графического интерфейса для политики типа {policy_type}

/api/webui/server/servicespools/{servicespool_uuid}/publications

GET

Возвращает список публикаций фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/publications/{uuid}

GET

Возвращает публикацию с идентификатором {uuid}

/api/webui/server/servicespools/{servicespool_uuid}/publications/{uuid}/cancel

GET

Запускает отмену публикации фонда РМ. Повторный вызов запускает форсированную отмену публикации фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/publications/gui

GET

Возвращает описание для графического интерфейса

/api/webui/server/servicespools/{servicespool_uuid}/publications/publish

GET

Запускает процедуру публикации фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/script

GET

Возвращает список скриптов фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/script

POST

Добавляет скрипт для фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/script/{uuid}

GET

Возвращает скрипт фонда рабочих мест

/api/webui/server/servicespools/{servicespool_uuid}/script/{uuid}

PUT

Обновляет скрипт фонда рабочих мест

/api/webui/server/servicespools/{servicespool_uuid}/script/{uuid}

DELETE

Удаляет скрипт из фонда рабочих мест

/api/webui/server/servicespools/{servicespool_uuid}/services

GET

Получает список назначенных РМ из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/services/{uuid}

GET

Возвращает назначенное РМ из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/services/{uuid}

DELETE

Удаляет назначенное РМ из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/services/{uuid}/execute_script

PATCH

Выполняет скрипт для назначенного РМ

/api/webui/server/servicespools/{servicespool_uuid}/services/{uuid}/log

GET

Возвращает журнал назначенного РМ

/api/webui/server/servicespools/{servicespool_uuid}/services/{uuid}/machine

PATCH

Управляет состоянием питания назначенного РМ

/api/webui/server/servicespools/{servicespool_uuid}/services/{uuid}/maintenance

PATCH

Управление режимом техобслуживания назначенного РМ

/api/webui/server/servicespools/{servicespool_uuid}/services/{uuid}/metrics

GET

Возвращает список метрик назначенного РМ

/api/webui/server/servicespools/{servicespool_uuid}/services/{uuid}/refresh

PATCH

Возвращает назначенную ВМ на базовый снапшот

/api/webui/server/servicespools/{servicespool_uuid}/services/{uuid}/replace

PATCH

Заменяет назначенный экземпляр ВМ на новый (запись в базе данных о РМ остается та же)

/api/webui/server/servicespools/{servicespool_uuid}/services/message

POST

Отправляет сообщения назначенным РМ

/api/webui/server/servicespools/{servicespool_uuid}/services/message/gui

GET

Возвращает описание для графического интерфейса метода отправки сообщения РМ

/api/webui/server/servicespools/{servicespool_uuid}/transports

GET

Возвращает список протоколов доставки из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/transports

POST

Добавляет протокол доставки в фонд РМ

/api/webui/server/servicespools/{servicespool_uuid}/transports/{uuid}

DELETE

Удаляет протокол доставки с идентификатором {uuid} из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/transports/gui

GET

Возвращает описание для графического интерфейса

/api/webui/server/servicespools/{servicespool_uuid}/users

GET

Возвращает список пользователей фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/users

POST

Добавляет пользователя в фонд РМ

/api/webui/server/servicespools/{servicespool_uuid}/users/{uuid}

DELETE

Удаляет пользователя из фонда РМ

/api/webui/server/servicespools/{servicespool_uuid}/users/gui

GET

Возвращает описание для графического интерфейса

/api/webui/server/servicespools/{uuid}

GET

Возвращает фонд РМ

/api/webui/server/servicespools/{uuid}

PUT

Обновляет фонд РМ

/api/webui/server/servicespools/{uuid}

DELETE

Удаляет фонд РМ

/api/webui/server/servicespools/{uuid}/log

GET

Возвращает журнал фонда РМ

/api/webui/server/servicespools/{uuid}/maintenance

PATCH

Переводит фонд РМ в режим техобслуживания и возвращает из него

/api/webui/server/servicespools/gui

GET

Возвращает описание для графического интерфейса

/api/webui/server/servicespools/types

GET

Возвращает список доступных типов для фондов РМ

Команды, связанные с группами РМ

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с группами РМ).

Таблица 34. Перечень URL-команд, связанных с группами РМ
URL-команда Тип Описание

/api/webui/server/spgroups

GET

Возвращает список групп

/api/webui/server/spgroups

POST

Создает группу

/api/webui/server/spgroups/{uuid}

GET

Возвращает группу с идентификатором {uuid}

/api/webui/server/spgroups/{uuid}

PUT

Обновляет группу

/api/webui/server/spgroups/{uuid}

DELETE

Удаляет группу

/api/webui/server/spgroups/gui

GET

Возвращает описание для графического интерфейса

Команды, связанные с сессиями пользователей

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с сессиями пользователей).

Таблица 35. Перечень URL-команд, связанных с сессиями пользователей
URL-команда Тип Описание

/api/webui/server/spsessions

GET

Возвращает список активных сессий пользователей

/api/webui/server/spsessions/{uuid}

GET

Возвращает активную сессию пользователя.

Пример запроса конкретной сессии через утилиту curl:

curl -X 'GET' \
  'https://disp.termidesk.local/api/webui/draft/spsessions?owner__iexact=user' \
  -H 'accept: application/json' \
  -H 'X-Auth-Token: 7bjqtodywjd69dkpdta9ncqprifkr3pu'

где:

disp.termidesk.local - IP-адрес или FQDN узла с «Универсальным диспетчером»;

user - пользователь;

X-Auth-Token - токен, использующийся для аутентификации запросов

/api/webui/server/spsessions/{uuid}/disconnect

PATCH

Сбрасывает активную сессию пользователя

/api/webui/server/spsessions/{uuid}/logoff

PATCH

Останавливает активную сессию пользователя

/api/webui/server/spsessions/{uuid}/metrics

GET

Получает метрики компонента «Агент виуртуальных рабочиих мест»

/api/webui/server/spsessions/{uuid}/policies

GET

Возвращает политики сессии пользователя

/api/webui/server/spsessions/{uuid}/raconnect

PATCH

Генерирует уникальный URL для подключения к «Удаленному помощнику»

/api/webui/server/spsessions/message

POST

Отправляет сообщение в пользовательскую сессию. Параметры для заполнения в запросе:

  • title - заголовок сообщения;

  • message - текст сообщения;

  • level - уровень важности. Может быть:

    • informational - информационное сообщение. Для пользователя отобразится сообщение с уровнем важности «informational»;

    • warning - предупреждение. Для пользователя отобразится сообщение с уровнем важности «warning»;

    • error - ошибка. Для пользователя отобразится сообщение с уровнем важности «error»;

  • confirmation - требование подтверждения о прочтении;

  • uuids - перечень уникальных идентификаторов сессий пользователя, в которые отправится сообщение

/api/webui/server/spsessions/message-stats/{group_id}

GET

Возвращает результат отправки сообщения

Команды, связанные с тегами

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с тегами).

Таблица 36. Перечень URL-команд, связанных с тегами
URL-команда Тип Описание

/api/webui/server/tags

GET

Возвращает список тегов

/api/webui/server/tags

POST

Создает тег

/api/webui/server/tags/{id}

GET

Возвращает тег

/api/webui/server/tags/{id}

PUT

Обновляет тег

/api/webui/server/tags/{id}

DELETE

Удаляет тег

/api/webui/server/tags/export

GET

Формирует файл экспорта тегов

/api/webui/server/tags/export

POST

Получает файл экспорта тегов

Команды, связанные с системными параметрами

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с системными параметрами).

Таблица 37. Перечень URL-команд, связанных с системными параметрами
URL-команда Тип Описание

/api/webui/server/tconfig

GET

Возвращает список системных параметров

/api/webui/server/tconfig

PUT

Сохраняет параметры конфигурации

Команды, связанные с протоколом доставки TERA

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с TERA).

Таблица 38. Перечень URL-команд, связанных с TERA
URL-команда Тип Описание

/api/webui/server/tera/{transport_uuid}/group-channels

GET

Возвращает список каналов приоритизации для протокола доставки TERA

/api/webui/server/tera/{transport_uuid}/group-channels/bulk_update

PATCH

Обновляет список каналов приоритизации для протокола доставки TERA

Команды, связанные с терминальными серверами

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с терминальными серверами).

Таблица 39. Перечень URL-команд, связанных с терминальными серверами
URL-команда Тип Описание

/api/webui/server/terminals

GET

Возвращает список терминальных серверов

/api/webui/server/terminals/{uuid}

GET

Возвращает терминальный сервер с идентификатором {uuid}

/api/webui/server/terminals/{uuid}/metrics

GET

Возвращает метрики терминального сервера с идентификатором {uuid}

Команды, связанные с протоколами доставки

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с протоколами доставки).

Таблица 40. Перечень URL-команд, связанных с протоколами доставки
URL-команда Тип Описание

/api/webui/server/transports

GET

Возвращает список протоколов доставки

/api/webui/server/transports

POST

Создает протокол доставки

/api/webui/server/transports/{uuid}

GET

Возвращает протокол доставки

/api/webui/server/transports/{uuid}

PUT

Обновляет протокол доставки

/api/webui/server/transports/{uuid}

DELETE

Удаляет протокол доставки

/api/webui/server/transports/export

GET

Формирует файл экспорта протоколов доставки

/api/webui/server/transports/export

POST

Получает файл экспорта протоколов доставки

/api/webui/server/transports/gui/{transport_type}

GET

Возвращает описание для графического интерфейса

/api/webui/server/transports/test/{transport_type}

POST

Тестирует параметры протокола доставки

/api/webui/server/transports/types

GET

Возвращает список типов протоколов доставки

Команды, связанные с управлением РМ

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с управлением РМ).

Таблица 41. Перечень URL-команд, связанных с управлением РМ
URL-команда Тип Описание

/api/webui/server/userservices/bulk/bulk-assign

PATCH

Назанчает пользователей на РМ

/api/webui/server/userservices/bulk/bulk-destroy

PATCH

Удаляет РМ

/api/webui/server/userservices/bulk/bulk-machine-state

PATCH

Управляет состоянием РМ

/api/webui/server/userservices/bulk/bulk-refresh

PATCH

Восстанавливает РМ

Команды, связанные с работой мастеров фонда РМ

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных с работой мастеров).

Таблица 42. Перечень URL-команд, связанных с работой мастеров
URL-команда Тип Описание

/api/webui/server/wizards

GET

Возвращает список мастеров

/api/webui/server/wizards/{uuid}

DELETE

Удаляет мастер с идентификатором {uuid}

/api/webui/server/wizards/{uuid}/finish

PATCH

Создает объект после валидации собранных данных. Удаляет мастер из временного хранилища

/api/webui/server/wizards/{uuid}/step/{step}

PATCH

Обрабатывает данные для указанного шага мастера

/api/webui/server/wizards/{uuid}/step/{step}/gui

GET

Возвращает спецификацию действий и полей

/api/webui/server/wizards/types

GET

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

Команды, связанные со списком РМ

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд, связанных со списком РМ).

Таблица 43. Перечень URL-команд, связанных со списком РМ
URL-команда Тип Описание

/api/webui/server/workplaces

GET

Возвращает список РМ

/api/webui/server/workplaces/{id}/tags

PATCH

Редактирует список тегов РМ

Доступные команды модуля «wsproxy»

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «wsproxy»).

Версия API /api/wsproxy/v1.1 удалена.
Таблица 44. Перечень URL-команд модуля «wsproxy»
URL-команда Тип Описание

/api/wsproxy/v7.0/verify/{token}

POST

Валидация токена шлюза для подключения к компоненту «Универсальный диспетчер» с поддержкой информации по протоколу TCP или UDP.

В запросе передается дополнительное поле proto с указанием значения протокола, по умолчанию TCP:

HTTP 200
{
  "host": "192.0.2.1",
  "port": 6195,
  "ssl_target": true,
  "proto": "tcp"
}