Документація VPS API: REST API для створення серверів і керування ними

Що можна робити через API

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

Якщо ви починаєте, пройдіть кроками посібник зі швидкого старту API: від створення ключа до першого сервера. Ця сторінка це довідник, де зібрано всі ендпоінти й поля.

Базова адреса

Усі запити надсилаються на шлях після адреси нижче. Тіла запитів і відповідей завжди в JSON (UTF-8).

https://helpervps.com/api/v1

Автентифікація

Надішліть заголовок Authorization: Bearer YOUR_API_KEY. Ви можете створити ключ у меню API ключів вашого акаунту після першої оплати; ключі починаються з hvp_. Повний ключ показується лише один раз одразу після створення, а створення нового ключа миттєво вимикає старий.

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

Ліміти запитів

Код сервера

Сервери розрізняються не за порядковим номером, а за кодом вигляду S-7K2M-9QX4-HB3T. Просто підставте в шлях значення id зі списку серверів або відповіді на створення. Регістр літер не важливий.

GET /catalog

Повертає одразу доступні тарифи (plans), регіони (locations), образи (images) і додаткові опції (addons). Усі коди для створення сервера беруться звідси. monthly це місячна ціна в доларах США, а недоступні опції приходять як null. monthly_per_gb додаткового диска показується з точністю до трьох знаків після коми.

Приклад запиту

curl https://helpervps.com/api/v1/catalog \
  -H "Authorization: Bearer YOUR_API_KEY"

Приклад відповіді

{
  "plans": [
    { "code": "s2", "type": "basic", "vcpu": 1, "ram_mb": 2048, "disk_gb": 50, "transfer_tb": 2, "monthly": "2.48" }
  ],
  "locations": ["frankfurt", "singapore", "seoul"],
  "images": ["ubuntu-24-04", "debian-13", "almalinux-10", "app-docker"],
  "addons": {
    "backups": { "percent_of_plan": 5.6 },
    "extra_disk": { "sizes_gb": [50, 100, 250, 500, 1000], "monthly_per_gb": "0.028" },
    "ddos_protection": { "monthly": "1.68" }
  }
}

GET /servers

Повертає список ваших серверів, починаючи з останніх створених. Видалені й нестворені сервери не включаються.

Приклад запиту

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

Приклад відповіді

[
  {
    "id": "S-7K2M-9QX4-HB3T",
    "label": "web-1",
    "state": "running",
    "ipv4": "192.0.2.15",
    "ipv6": "2001:db8::15",
    "monthly": "2.48",
    "backups": false,
    "extra_disk_gb": 0,
    "ddos_protection": false,
    "paid_until": "2026-11-18T09:00:00.000Z"
  }
]

POST /servers

Створює сервер і обробляє оплату. Використовуйте коди з каталогу для тарифу, розташування та образу як є. label може містити до 40 латинських літер, цифр, крапок і дефісів; інші символи замінюються на дефіси. backups, extra_disk_gb і ddos_protection є необов'язковими. У разі успіху ви отримаєте відповідь 201 з деталями сервера, і root_password включається один раз у цій відповіді (ви також можете переглянути його на сторінці сервера у вашому акаунті протягом 7 днів).

Приклад запиту

curl -X POST https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan":"s2","location":"frankfurt","image":"ubuntu-24-04","label":"web-1","backups":true,"extra_disk_gb":0,"ddos_protection":false}'

Приклад відповіді

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "creating",
  "ipv4": null,
  "ipv6": null,
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z",
  "root_password": "..."
}

GET /servers/{id}

Повертає статус і адреси одного сервера, місячну ціну та дату закінчення оплаченого періоду. Новий сервер починається зі статусу creating, після готовності переходить у running, і заповнюються ipv4 та ipv6. Достатньо перевіряти раз на кілька секунд.

Приклад запиту

curl https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

Приклад відповіді

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "running",
  "ipv4": "192.0.2.15",
  "ipv6": "2001:db8::15",
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z"
}

POST /servers/{id}/start (stop, reboot)

start вмикає зупинений (stopped) сервер, а stop і reboot вимикають або перезапускають працюючий (running) сервер. У відповіді приходять оновлені дані сервера.

Приклад запиту

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/reboot \
  -H "Authorization: Bearer YOUR_API_KEY"

Приклад відповіді

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "rebooting",
  ...
}

POST /servers/{id}/renew

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

Приклад запиту

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/renew \
  -H "Authorization: Bearer YOUR_API_KEY"

Приклад відповіді

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "running",
  "paid_until": "2026-12-18T09:00:00.000Z",
  ...
}

DELETE /servers/{id}

Видаляє сервер і диски. З наступної дати оплати списань немає, а залишок уже оплаченого місяця не повертається.

Приклад запиту

curl -X DELETE https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

Приклад відповіді

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "deleted"
}

Поля відповіді сервера

Значення статусу

Помилки

У разі помилки разом із кодом статусу повертається JSON вигляду {"error": "код"}. Обробляйте помилки за значенням коду.

Корисні посібники

Оплата здійснюється через безпечну сторінку оплати PayGate. Ви можете перевстановити та створити новий пароль root на сторінці сервера у вашому акаунті; кроки описані в посібнику з перевстановлення.

Можливості API та приклади автоматизації на сторінці VPS API, а місячні ціни за тарифами на сторінці цін.