REST API. Доступные команды. Webui

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

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных со списками устройств доступа

URL-команда	Тип	Описание
`/api/webui/v1/access-devices`	GET	Возвращает список устройств доступа
`/api/webui/v1/access-devices/{uuid}`	GET	Возвращает устройство доступа с идентификатором `{uuid}`
`/api/webui/v1/access-devices/{uuid}/{status}`	PATCH	Изменяет статус устройства доступа c идентификатором `{uuid}`
`/api/webui/v1/access-devices/overview`	GET	Возвращает список устройств доступа

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных со списками доступа

URL-команда	Тип	Описание
`/api/webui/v1/acl`	GET	Возвращает список объектных разрешений
`/api/webui/v1/acl`	POST	Обновляет объектное разрешение
`/api/webui/v1/acl/{ID}`	GET	Возвращает объектное разрешение c идентификатором `{ID}`
`/api/webui/v1/acl/{ID}`	PUT	Обновляет объектное разрешение c идентификатором `{ID}`
`/api/webui/v1/acl/{ID}`	DELETE	Удаляет объектное разрешение c идентификатором `{ID}`
`/api/webui/v1/acl/gui/{data_type}`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/acl/types`	GET	Возвращает список доступных типов объектных разрешений
`/api/webui/v1/acl/overview`	GET	Возвращает список объектных разрешений

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

Доступные администратору URL-команды перечислены в таблице.

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

URL-команда	Тип	Описание
`/api/webui/v1/audit/events`	GET	Возвращает список событий аудита действий пользователей
`/api/webui/v1/audit/events?limit={limit}&offset={offset}`	GET	Возвращает список событий аудита с ограничением `{limit}` и смещением `{offset}`
`/api/webui/audit/events?event_name={event_type}`	GET	Возвращает список событий аудита с типом `{event_type}`
`/api/webui/v1/audit/events/types`	GET	Возвращает список доступных типов событий аудита
`/api/webui/v1/audit/events/overview`	GET	Возвращает список событий аудита
`/api/webui/v1/monitoring`	GET	Возвращает список событий общего журнала
`/api/webui/v1/monitoring/overview`	GET	Возвращает список событий общего журнала

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с доменами аутентификации

URL-команда	Тип	Описание
`/api/webui/v1/authenticators`	GET	Возвращает список доменов аутентификации
`/api/webui/v1/authenticators`	POST	Создает домен аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups`	GET	Возвращает список групп домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups`	POST	Создает группу домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups/{uuid}`	GET	Возвращает группу с идентификатором `{uuid}` домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups/{uuid}`	PUT	Обновляет группу домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups/{uuid}`	DELETE	Удаляет группу домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups/{uuid}/servicesPools`	GET	Возвращает список ВРМ группы домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups/{uuid}/users`	GET	Возвращает список пользователей группы домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups/external`	GET	Возвращает список доступных групп для домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups/types`	GET	Возвращает список доступных типов групп домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/groups/gui/{group_type}`	GET	Возвращает описание для графического интерфейса группы с типом `{group_type}`
`/api/webui/v1/authenticators/{auth_uuid}/groups/overview`	GET	Возвращает список групп домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users`	GET	Возвращает список пользователей домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users`	POST	Создает пользователя домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users/{uuid}`	GET	Возвращает пользователя с идентификатором `{uuid}` домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users/{uuid}`	PUT	Обновляет пользователя домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users/{uuid}`	DELETE	Удаляет пользователя домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users/{uuid}/log`	GET	Возвращает журнал пользователя домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users/{uuid}/servicesPools`	GET	Возвращает список ВРМ пользователя домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users/{uuid}/userServices`	GET	Возвращает список ассоциированных виртуальных машин для пользователя домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users/external`	GET	Возвращает список доступных пользователей для домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/authenticators/{auth_uuid}/users/types`	GET	Возвращает список доступных типов пользователей домена аутентификации
`/api/webui/v1/authenticators/{auth_uuid}/users/overview`	GET	Возвращает список пользователей домена аутентификации
`/api/webui/v1/authenticators/{uuid}`	GET	Возвращает домен аутентификации
`/api/webui/v1/authenticators/{uuid}`	PUT	Обновляет домен аутентификации
`/api/webui/v1/authenticators/{uuid}`	DELETE	Удаляет домен аутентификации
`/api/webui/v1/authenticators/{uuid}/log`	GET	Возвращает журнал домена аутентификации
`/api/webui/v1/authenticators/types`	GET	Возвращает список доступных типов доменов аутентификации
`/api/webui/v1/authenticators/gui/{data_type}`	GET	Возвращает описание для графического интерфейса домена аутентификации с типом `{data_type}`
`/api/webui/v1/authenticators/test/{type}`	POST	Тестирует параметры домена аутентификации
`/api/webui/v1/authenticators/overview`	GET	Возвращает список доменов аутентификации

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

Доступные администратору URL-команды перечислены в таблице.

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

URL-команда	Тип	Описание
`/api/webui/v1/dashboard`	GET	Просмотр отображения панели мониторинга
`/api/webui/v1/dashboard/overview`	GET	Просмотр отображения панели мониторинга

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

Доступные администратору URL-команды перечислены в таблице.

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

URL-команда	Тип	Описание
`/api/webui/v1/gallery/images`	GET	Возвращает список изображений
`/api/webui/v1/gallery/images`	POST	Создает изображение
`/api/webui/v1/gallery/images/{uuid}`	GET	Возвращает изображение с идентификатором `{uuid}`
`/api/webui/v1/gallery/images/{uuid}`	PUT	Обновляет изображение
`/api/webui/v1/gallery/images/{uuid}`	DELETE	Удаляет изображение
`/api/webui/v1/gallery/images/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/gallery/images/overview`	GET	Возвращает список изображений

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с вызовом функций графического интерфейса

URL-команда	Тип	Описание
`/api/webui/v1/gui/callback/{callback}`	GET	Доступ к callback-функциям графического интерфейса

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

Доступные администратору URL-команды перечислены в таблице.

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

URL-команда	Тип	Описание
`/api/webui/v1`	GET	Определяет текущую версию REST API

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с функциями мониторинга

URL-команда	Тип	Описание
`/api/webui/v1/monitoring`	GET	Просмотр всех журналов в виде списка
`/api/webui/v1/monitoring/overview`	GET	Просмотр всех журналов в виде списка

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с IP-аутентификацией

URL-команда	Тип	Описание
`/api/webui/v1/networks`	GET	Возвращает список сетей
`/api/webui/v1/networks`	POST	Создает сеть
`/api/webui/v1/networks/{uuid}`	GET	Возвращает сеть с идентификатором `{uuid}`
`/api/webui/v1/networks/{uuid}`	PUT	Обновляет сеть
`/api/webui/v1/networks/{uuid}`	DELETE	Удаляет сеть
`/api/webui/v1/networks/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/networks/overview`	GET	Возвращает список сетей

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

Доступные администратору URL-команды перечислены в таблице.

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

URL-команда	Тип	Описание
`/api/webui/v1/osmanagers`	GET	Возвращает список параметров гостевых ОС
`/api/webui/v1/osmanagers`	POST	Создает параметры гостевых ОС
`/api/webui/v1/osmanagers/{uuid}`	GET	Возвращает параметры гостевых ОС с идентификатором `{uuid}`
`/api/webui/v1/osmanagers/{uuid}`	PUT	Обновляет параметры гостевых ОС
`/api/webui/v1/osmanagers/{uuid}`	DELETE	Удаляет параметры гостевых ОС
`/api/webui/v1/osmanagers/types`	GET	Возвращает список типов параметров гостевых ОС
`/api/webui/v1/osmanagers/gui/{data_type}`	GET	Возвращает описание для графического интерфейса для параметров с типом `{data_type}`
`/api/webui/v1/osmanagers/overview`	GET	Возвращает список параметров гостевых ОС

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

Доступные администратору URL-команды перечислены в таблице.

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

URL-команда	Тип	Описание
`/api/webui/v1/policies`	GET	Список всех доступных политик
`/api/webui/v1/policies/{data_type}`	GET	Получить информацию о политике с типом `{data_type}`
`/api/webui/v1/policies/{data_type}`	PUT	Обновить параметры политики
`/api/webui/v1/policies/{data_type}`	DELETE	Сброс глобальной политики
`/api/webui/v1/policies/gui/{data_type}`	GET	Спецификация полей графического интерфейса для политики конкретного типа
`/api/webui/v1/policies/overview`	GET	Список всех доступных политик

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с поставщиками ресурсов

URL-команда	Тип	Описание
`/api/webui/v1/providers`	GET	Возвращает список поставщиков ресурсов
`/api/webui/v1/providers`	POST	Создает поставщика ресурсов
`/api/webui/v1/providers/{uuid}`	GET	Возвращает поставщик ресурсов с идентификатором `{uuid}`
`/api/webui/v1/providers/{uuid}`	PUT	Обновляет поставщик ресурсов
`/api/webui/v1/providers/{uuid}`	DELETE	Удаляет поставщик ресурсов
`/api/webui/v1/providers/{uuid}/maintenance`	PATCH	Переводит поставщик ресурсов в режим техобсуживания
`/api/webui/v1/providers/types`	GET	Возвращает список доступных типов поставщиков техобслуживания
`/api/webui/v1/providers/test/{prov_type}`	POST	Тестирует параметры поставщика ресурсов
`/api/webui/v1/providers/gui/{prov_type}`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/providers/{provider_uuid}/services`	GET	Возвращает список шаблонов ВРМ поставщика ресурсов
`/api/webui/v1/providers/{provider_uuid}/services`	POST	Создает шаблон ВРМ
`/api/webui/v1/providers/{provider_uuid}/services/{uuid}`	GET	Возвращает шаблон ВРМ с идентификатором `{uuid}` поставщика ресурсов
`/api/webui/v1/providers/{provider_uuid}/services/{uuid}`	PUT	Обновляет шаблон ВРМ с идентификатором `{uuid}` поставщика ресурсов
`/api/webui/v1/providers/{provider_uuid}/services/{uuid}`	DELETE	Удаляет шаблон ВРМ с идентификатором `{uuid}` поставщика ресурсов
`/api/webui/v1/providers/{provider_uuid}/services/types`	GET	Возвращает список доступных типов шаблонов ВРМ поставщика ресурсов
`/api/webui/v1/providers/{provider_uuid}/services/gui/{service_type}`	GET	Возвращает описание для графического интерфейса для шаблона ВРМ с типом `{service_type}` поставщика ресурсов
`/api/webui/v1/providers/{provider_uuid}/services/overview`	GET	Возвращает список шаблонов ВРМ
`/api/webui/v1/providers/overview`	GET	Возвращает список поставщиков ресурсов

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

Доступные администратору URL-команды перечислены в таблице.

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

URL-команда	Тип	Описание
`/api/webui/v1/rbac`	GET	Возвращает список ролей
`/api/webui/v1/rbac`	POST	Создает роль
`/api/webui/v1/rbac/{id}`	GET	Возвращает роль
`/api/webui/v1/rbac/{id}`	PUT	Обновляет роль
`/api/webui/v1/rbac/{id}`	DELETE	Удаляет роль
`/api/webui/v1/rbac/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/rbac/overview`	GET	Возвращает список ролей

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с фондами ВРМ

URL-команда	Тип	Описание
`/api/webui/v1/servicespools`	GET	Возвращает список фондов ВРМ
`/api/webui/v1/servicespools`	POST	Создает фонд ВРМ
`/api/webui/v1/servicespools/{uuid}`	GET	Возвращает фонд ВРМ
`/api/webui/v1/servicespools/{uuid}`	PUT	Обновляет фонд ВРМ
`/api/webui/v1/servicespools/{uuid}`	DELETE	Удаляет фонд ВРМ
`/api/webui/v1/servicespools/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/servicespools/types`	GET	Возвращает список доступных типов для фондов ВРМ
`/api/webui/v1/servicespools/overview`	GET	Возвращает список фондов ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/groups`	GET	Возвращает список групп фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/groups`	POST	Добавляет группу в фонд ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/groups/{uuid}`	GET	Набор операций для управления группой из фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/groups/{uuid}`	DELETE	Удаляет группу с идентификатором `{uuid}` из фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/groups/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/servicespools/{servicepool_uuid}/groups/overview`	GET	Возвращает список групп фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/policies`	GET	Список всех политик фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/policies/{data_type}`	GET	Получить информацию о политиках фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/policies/{data_type}`	PUT	Обновить параметры политики фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/policies/{data_type}`	DELETE	Сброс политики фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/policies/gui/{data_type}`	GET	Спецификация полей графического интерфейса для политики типа `{data_type}`
`/api/webui/v1/servicespools/{servicepool_uuid}/policies/overview`	GET	Список всех политик фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/publications/publish`	GET	Запускает процедуру публикации фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/publications`	GET	Возвращает список публикаций фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/publications/{uuid}`	GET	Возвращает публикацию с идентификатором `{uuid}`
`/api/webui/v1/servicespools/{servicepool_uuid}/publications/{uuid}/cancel`	GET	Запускает отмену публикации фонда ВРМ. Повторный вызов запускает форсированную отмену публикации фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/publications/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/servicespools/{servicepool_uuid}/publications/overview`	GET	Возвращает список публикаций фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/transports`	GET	Возвращает список протоколов доставки из фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/transports`	POST	Добавляет протокол доставки в фонд ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/transports/{uuid}`	GET	Возвращает протокол доставки с идентификатором `{uuid}` из фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/transports/{uuid}`	DELETE	Удаляет протокол доставки с идентификатором `{uuid}` из фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/transports/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/servicespools/{servicepool_uuid}/transports/overview`	GET	Возвращает список протоколов доставки из фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/users`	GET	Возвращает список пользователей фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/users`	POST	Добавляет пользователя в фонд ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/users/{uuid}`	GET	Набор операций для управления пользователями из фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/users/{uuid}`	DELETE	Удаляет пользователя из фонда ВРМ
`/api/webui/v1/servicespools/{servicepool_uuid}/users/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/servicespools/{servicepool_uuid}/users/overview`	GET	Возвращает список пользователей фонда ВРМ
`/api/webui/v1/servicespools/{uuid}/cache`	GET	Получение списка ВРМ в кеше
`/api/webui/v1/servicespools/{uuid}/cache/{service_uuid}`	DELETE	Удаление кешированного ВРМ
`/api/webui/v1/servicespools/{uuid}/cache/{service_uuid}/log`	GET	Получение журнала для ВРМ из кеша
`/api/webui/v1/servicespools/{uuid}/cache/{service_uuid}/machine`	PATCH	Управление состоянием выбранного кешированного ВРМ
`/api/webui/v1/servicespools/{uuid}/cache/overview`	GET	Получение списка ВРМ в кеше
`/api/webui/v1/servicespools/{uuid}/log`	GET	Возвращает журнал фонда ВРМ
`/api/webui/v1/servicespools/{uuid}/services`	GET	Получение списка назначенных ВРМ
`/api/webui/v1/servicespools/{uuid}/services/{service_uuid}`	DELETE	Удаление назначенного ВРМ
`/api/webui/v1/servicespools/{uuid}/services/{service_uuid}/log`	GET	Получение журнала назначенного ВРМ
`/api/webui/v1/servicespools/{uuid}/services/{service_uuid}/machine`	PATCH	Управление состоянием выбранного ВРМ
`/api/webui/v1/servicespools/{uuid}/services/{service_uuid}/refresh`	PATCH	Откат назначенного ВРМ на базовый снапшот
`/api/webui/v1/servicespools/{uuid}/services/message`	POST	Отправка сообщения назначенным ВРМ
`/api/webui/v1/servicespools/{uuid}/services/message/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/servicespools/{uuid}/services/overview`	GET	Получение списка назначенных ВРМ

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с группами ВРМ

URL-команда	Тип	Описание
`/api/webui/v1/spgroups`	GET	Возвращает список групп
`/api/webui/v1/spgroups`	POST	Создает группу
`/api/webui/v1/spgroups/{uuid}`	GET	Возвращает группу с идентификатором `{uuid}`
`/api/webui/v1/spgroups/{uuid}`	PUT	Обновляет группу
`/api/webui/v1/spgroups/{uuid}`	DELETE	Удаляет группу
`/api/webui/v1/spgroups/gui`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/spgroups/overview`	GET	Возвращает список групп

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

Доступные администратору URL-команды перечислены в таблице.

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

URL-команда	Тип	Описание
`/api/webui/v1/spsessions`	GET	Возвращает список активных сессий пользователей
`/api/webui/v1/spsessions/{uuid}`	GET	Возвращает активную сессию пользователя
`/api/webui/v1/spsessions/{uuid}/disconnect`	PATCH	Сбрасывает активную сессию пользователя
`/api/webui/v1/spsessions/{uuid}/logoff`	PATCH	Останавливает активную сессию пользователя
`/api/webui/v1/spsessions/overview`	GET	Возвращает список активных сессий пользователей

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

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с системными параметрами

URL-команда	Тип	Описание
`/api/webui/v1/tconfig`	GET	Возвращает список системных параметров
`/api/webui/v1/tconfig`	PUT	Сохранение параметров конфигурации
`/api/webui/v1/tconfig/overview`	GET	Возвращает список системных параметров

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

Доступные администратору URL-команды перечислены в таблице.

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

URL-команда	Тип	Описание
`/api/webui/v1/transports`	GET	Возвращает список протоколов доставки
`/api/webui/v1/transports`	POST	Создает протокол доставки
`/api/webui/v1/transports/{uuid}`	GET	Возвращает протокол доставки
`/api/webui/v1/transports/{uuid}`	PUT	Обновляет протокол доставки
`/api/webui/v1/transports/{uuid}`	DELETE	Удаляет протокол доставки
`/api/webui/v1/transports/types`	GET	Возвращает список типов протоколов доставки
`/api/webui/v1/transports/gui/{transport_type}`	GET	Возвращает описание для графического интерфейса
`/api/webui/v1/transports/test/{transport_type}`	POST	Тестирует параметры протокола доставки
`/api/webui/v1/transports/overview`	GET	Возвращает список протоколов доставки