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?

API VPS безкоштовний для всіх користувачів. Сервери та опції, створені через 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 безкоштовний?

Так, API VPS безкоштовний для всіх користувачів. Випуск 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

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

Ліміт запитів: 300 на хвилину на API ключ | 10 серверів на акаунт | У разі невдалої оплати: сервер призупиняється, потім видаляється через 3 дні | Залишок часу на видалених серверах не повертається. Повернення надходять на кредит вашого акаунту.