Swagger — это интерактивная оболочка для изучения работы API. С помощью Swagger вы можете сгенерировать запрос для API-функции платформы и проверить как эта функция работает.
Чтобы открыть Swagger, в правом меню нажмите → Swagger:
Переход в интерфейс Swagger
Swagger содержит описание API VMmanager, модуля IPmanager 6 и сервиса авторизации. Для переключения между ними выберите нужный раздел в поле Select a definition:
vm — API VMmanager;
ipmgr — API IPmanager 6;
auth — API сервиса авторизации.
Выбор раздела
Выполнение API-запросов
Обратите внимание!
API-запросы выполняются с реальными объектами платформы. Перед выполнением запроса убедитесь, что выполняемые действия не нарушат работу VMmanager.
Чтобы выполнить запрос:
Выберите нужную функцию и нажмите Try it out.
Введите требуемые параметры и тело запроса и нажмите Execute.
После выполнения запроса в разделе Responses отображается формат запроса для утилитыcurl и ответ сервера.