VMmanager

Использование Swagger

Swagger — это интерактивная оболочка для изучения работы API. С помощью Swagger вы можете сгенерировать запрос для API-функции платформы и проверить как эта функция работает.

Чтобы перейти к веб-интерфейсу Swagger, в правом меню нажмите значок Swagger.

Интерфейс Swagger доступен по URL https://domain.com/swagger/.

Пояснения к URL

Разделы Swagger

Swagger содержит описание API следующих сервисов VMmanager:

  • vm — основной сервис платформы. Подробнее см. VMmanager API;
  • auth_v4 — сервис авторизации. Подробнее см. Auth API v4;
  • ipmgr — сервис для работы с IP-адресами, пулами и сетями. Подробнее см. IPmanager 6;
  • rDNS proxy service — сервис для работы с обратными PTR-записями. Для работы с сервисом установите модуль "Интеграция с DNSmanager 6". Без установленного модуля API-запросы будут выдавать ошибку 404. Подробнее о модуле см. Модуль "Интеграция с DNSmanager 6";
  • uploader — сервис загрузки ISO-образов.

Чтобы переключаться между сервисами, выберите нужный раздел в поле Select a definition.

Выбор раздела

Выполнение API-запросов

API-запросы выполняются с реальными объектами платформы. Перед выполнением запроса убедитесь, что выполняемые действия не нарушат работу VMmanager.

Чтобы выполнить запрос:

  1. Выберите нужную функцию и нажмите Try it out.
  2. Введите требуемые параметры и тело запроса и нажмите Execute.

После выполнения запроса в разделе Responses отображается формат запроса для утилиты curl и ответ сервера.

Интерфейс раздела

Примеры использования

Изменение времени жизни сессии

  1. В поле Select a definition выберите раздел Auth v4.
  2. Выберите POST-запрос /setting/{name}.
  3. Нажмите кнопку Try it out.
  4. В поле Name введите token_ttl.
  5. В поле Request body введите тело запроса:

    {
      "value": "<time>"
    }

    <time> — требуемое время жизни сессии в мин

  6. Нажмите кнопку Execute.

Может быть полезно