HELPER VPS

VPS API: автоматизация облачных серверов через JSON REST

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

  • JSON REST API
  • Аутентификация по API ключу (Bearer)
  • 300 запросов в минуту

VPS API , это программный способ выполнять задачи, которые вы обычно делаете в панели управления, такие как создание, запуск, остановка и удаление серверов, с помощью HTTP-запросов. API облачных серверов HELPER VPS бесплатен для всех пользователей; после первой оплаты создайте API-ключ и подключитесь сразу.

  • REST API

    Все пользователи

    Бесплатно

    Ежемесячная оплата

    • JSON REST
    • API ключ (Bearer)
    • 300 в минуту
    • Бесплатно
    Начать

Чтобы сразу посмотреть примеры запросов и формат ответов Документация API

Что можно автоматизировать через VPS API?

VPS API раскрывается, когда серверы часто создаются и удаляются или нужно управлять многими серверами сразу. Вот четыре популярных сценария автоматизации.

Панель управления или VPS API: когда что использовать?

Панель управления и API работают с одним и тем же аккаунтом и серверами. Для управления одним или двумя серверами вручную удобна панель управления; для повторяющихся задач или множества серверов быстрее использовать API.

Панель управления

Управление нажатиями в интерфейсе

Кому подойдёт

  • Когда создаёте сервер впервые
  • Когда сами ведёте один-два сервера
  • Переустановка ОС и добавление SSH ключей
  • Когда нужно снова посмотреть пароль root

VPS API

Управление запросами из кода

Кому подойдёт

  • Тестовые среды, где серверы часто создаются и удаляются
  • Конвейеры деплоя и автоматизация скриптами
  • Когда нужно сразу прочитать состояние многих серверов
  • Когда подключаете свою админку или бота

Как подключить API облачных серверов?

Это происходит в три шага. Сначала сделайте первую оплату, и после её подтверждения создайте ключ на странице API-ключей. Затем укажите ключ в заголовке Authorization каждого запроса по схеме Bearer. Наконец, отправляйте запросы на нужный путь после базового адреса https://helpervps.com/api/v1, и результат вернётся в формате JSON.

Для начала полезно вызвать GET /catalog. Он сразу возвращает доступные типы и размеры серверов, коды регионов, коды ОС и приложений в один клик, а также цены автобэкапа, дополнительного диска и защиты от DDoS. Полученные коды plan, location и image просто подставьте в запрос на создание сервера.

Чтобы создать сервер, отправьте значения plan, location, image и label в формате JSON на POST /servers. Вы также можете включить ID добавленного SSH-ключа и опции backups, extra_disk_gb и ddos_protection. Вы оплачиваете выбранный период заранее, а в ответе содержатся ID сервера, статус и пароль root, поэтому сразу сохраните их в надёжном месте.

Какие действия доступны через VPS API?

VPS API покрывает весь жизненный цикл сервера. GET /catalog читает каталог, POST /servers создаёт сервер, GET /servers возвращает список ваших серверов, а GET /servers/{id} данные одного сервера. В ответе есть имя сервера, статус, адреса IPv4 и IPv6, месячная цена, выбранные опции и следующая дата оплаты.

Питание управляется запросами POST /servers/{id}/start, stop и reboot. POST /servers/{id}/renew оплачивает месяц прямо сейчас, не дожидаясь даты оплаты, а DELETE /servers/{id} удаляет сервер. Если запрос не подходит к текущему состоянию сервера, приходит код wrong_state, и скрипту легко решить, что делать дальше.

Ошибки возвращаются в JSON со значением error вместе с кодом статуса. Причины разделены кодами: неверный ключ unauthorized, нехватка баланса not_enough_balance, лимит серверов аккаунта limit, слишком много запросов rate_limited, так что в программе удобно обрабатывать каждую ситуацию. Полный список и примеры ответов есть в документации API.

Сколько стоит VPS API?

VPS API бесплатен для всех пользователей. Серверы и опции, созданные через API, оплачиваются по тем же ценам, что и серверы, созданные в панели управления.

HELPER VPS в цифрах

Выберите из 40 регионов, 12 операционных систем и 10 приложений в один клик в одном аккаунте и оплатите сразу. Цифры ниже основаны на текущем каталоге.

Инструменты автоматизации для работы с VPS API

К VPS API подключается любой инструмент, который умеет отправлять HTTP запросы. От одной строки curl до скриптов на Python и Node.js и конвейеров деплоя всё работает одинаково.

  • Terraform
  • Python
  • Node.js
  • GitLab CI
  • Docker

Почему выбирают API HELPER VPS

Частые вопросы о VPS API

Ответы о подключении, аутентификации и лимитах запросов VPS API

VPS API бесплатный?

Да, VPS API бесплатен для всех пользователей. Выпуск API-ключей и выполнение запросов бесплатны, а серверы и опции, созданные через API, оплачиваются по тем же ценам, что и созданные в панели управления. Любой пользователь, сделавший первую оплату, может сразу создать ключ на странице API-ключей.

Где создать API ключ?

После первой оплаты открывается страница API-ключей (/api-key), где вы создаёте ключи. Укажите ключ в заголовке Authorization каждого запроса по схеме Bearer. Ключ открывает доступ ко всему аккаунту, поэтому не добавляйте его в репозитории кода; храните его в переменных окружения или хранилище секретов.

Какие действия доступны через API?

Можно читать каталог (GET /catalog), список серверов и данные одного сервера (GET /servers, GET /servers/{id}), создавать сервер (POST /servers), включать, выключать и перезагружать (start, stop, reboot), продлевать на месяц (renew) и удалять (DELETE /servers/{id}). Примеры запросов и формат ответов есть в документации API.

Какой лимит запросов?

До 300 запросов в минуту на ключ. При превышении лимита возвращаются код статуса 429 и ошибка rate_limited, поэтому в скрипте достаточно немного подождать и отправить снова. Повседневная автоматизация, как проверка списка серверов и управление питанием, работает в этом лимите с запасом. Платы за число запросов нет.

Как списывается плата при создании сервера через API?

Когда запрос POST /servers успешен, оплата за выбранный период обрабатывается, и сервер создаётся. Оплата за сервер, который не удалось создать, возвращается на кредит вашего аккаунта.

Как получить пароль root через API?

Значение root_password один раз приходит в ответе на запрос создания сервера. Сохраните его в надёжном месте сразу после получения ответа. В панели управления его тоже можно посмотреть в течение 7 дней, а если передать и номер SSH ключа, вход сразу идёт по ключу без пароля. По значению ipv4 из ответа можно сразу начать подключение по SSH, что удобно связывать со скриптами деплоя.

Можно ли передать SSH ключ через API?

Да, укажите в запросе создания сервера номер добавленного SSH ключа в значении ssh_key_id, и этот ключ попадёт на новый сервер. Ключ достаточно один раз добавить на экране SSH ключей в панели, а отпечаток показывается так же, как в ssh-keygen, поэтому сразу видно, какой это ключ. Номер ключа задаётся один раз и используется повторно.

С какими языками и инструментами работает API?

Подойдёт любой язык и инструмент, умеющий отправлять HTTP запросы. Проверяйте сразу через curl, а из requests в Python, fetch в Node.js, шага скрипта GitLab CI и HTTP запросов Terraform вызывайте тот же адрес с теми же заголовками. Все ответы в JSON, поэтому результат легко читать.

Как узнать об ошибке?

Ошибка возвращается с кодом статуса не 2xx и JSON со значением error. Причины разделены: неверный ключ unauthorized, отсутствующее значение bad_request, нехватка баланса not_enough_balance, запрос, не подходящий к состоянию сервера, wrong_state, так что в программе удобно обрабатывать каждую ситуацию.

Видны ли серверы, созданные через API, в панели?

Да, API и панель работают с тем же аккаунтом и теми же серверами. Серверы, созданные через API, видны в списке панели, а в панели можно переустановить ОС или посмотреть пароль. Лимит 10 серверов на аккаунт действует для обоих способов вместе. Даже если смешивать ручную работу и код, статус и даты оплаты всегда видны одинаково.

Руководства по VPS API

Полезные материалы при первом подключении API

VPS API бесплатен для всех пользователей, а API ключ можно создать после первого платежа. Серверы и опции, созданные через API, оплачиваются по ценам из прайс-листа и автоматически продлеваются на ту же сумму в каждую дату оплаты.

Лимит запросов: 300 в минуту на API ключ | 10 серверов на аккаунт | При неудачном платеже: сервер приостанавливается, затем удаляется через 3 дня | Остаток срока удалённого сервера не возвращается. Возвраты поступают на кредит вашего аккаунта.