VPS.org API

Документація з програмного інтерфейсу REST

Документація з VPS.org програм API

Повна документація REST API для керування VPS-серверами, доменами, DNS, резервними копіями тощо.

Базова URL-адреса https://admin.vps.org/api/v1
Автентифікація Токен на пред'явника
Версія v1
Формат JSON

Початок роботи

API VPS.org дозволяє програмно керувати всіма аспектами інфраструктури вашого VPS-хостингу, включаючи сервери, домени, DNS-записи, резервні копії та знімки.

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

Усі запити API вимагають автентифікації за допомогою токена-носія. Ви можете згенерувати свій токен API у налаштуваннях облікового запису за адресою admin.vps.org/account/developers/.

cURL
Python
JavaScript
curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Кожен токен має власні дозволи, наприклад servers:list або dns:*. Запит, що потребує дозволу, якого немає у токена, відхиляється з кодом 403 і полем required_permission із назвою відсутнього дозволу. Довідка щодо дозволів

Обмеження швидкості

Автентифіковані запити обмежені 1000 на годину для облікового запису. Неавтентифіковані запити обмежені 100 на годину для IP-адреси. Запит понад ліміт отримує 429 із заголовком Retry-After, що вказує кількість секунд очікування. Для успішних відповідей заголовки ліміту не надсилаються.

Pagination

В кінці списку буде повернуто об' єкт зі сумою, наступним, попереднім і результатами, 25 пунктів на сторінку. Передайте сторінку, яку слід пересунути між сторінками, або натисніть наступну адресу URL, аж доки вона не буде нульовою. У списку серверів також передбачено розмір сторінки до 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Обробка помилок

API використовує стандартні коди стану HTTP для позначення успіху або невдачі:

Код стану Опис
200 Успіх – Запит успішно виконано
201 Створено – Ресурс успішно створено
400 Неправильний запит – недійсні параметри або неправильно сформований запит
202, 204 Прийнято і поставлено у чергу (202), або вилучено без відповіді (204)
402 Потрібна сплата: без методу сплати за файлами, неоплачуваних рахунків або попередньої уповноваження на картку
403 Заборонено: не вказано ключа, не є коректним або застарілим, або у нього немає потрібних дозволів. Не вдалося розпізнавання також повертає 403, а не 401.
404 Не знайдено – ресурс не існує
409 Конфлікт: наприклад, зміна розміру, яку вже було виконано, недостатньо місткості або можливість виконання вже запущеної програми
429 Забагато запитів – перевищено ліміт швидкості
500 Внутрішня помилка сервера – Щось пішло не так з нашого боку
503 Служба недоступна: тимчасова проблема. Спробуйте ще раз, з нагоди її надсилання, з почестями повторіть спробу.

Тіла помилок - JSON. Більшість з них мають поле подробиць або поле помилки, іноді у повідомленні; перевірка помилок призводить до показу проблем за назвою поля.

Категорії API

Перегляньте нашу документацію API за категоріями:

API серверів 15 Кінцеві точки

Створення, перевірка, зміна параметрів, зміна розміру і вилучення серверів, відновлення паролів адміністратора, встановлення зворотного значення DNS, виконання команд і керування ключами SSH.

Переглянути документацію
API резервних копій 4 Кінцеві точки

Список резервних копій вашого сервера, створення резервної копії і відновлення сервера з резервної копії.

Переглянути документацію
API знімків 4 Кінцеві точки

Зробити з міткою знімки сервера, показати список і вилучити їх.

Переглянути документацію
API планів 2 Кінцеві точки

Отримайте доступні плани VPS та інформацію про ціни. Отримайте детальну інформацію про ресурси, ціни та доступність.

Переглянути документацію
API операційних систем 2 Кінцеві точки

Список операційних систем і версій, які ви можете встановити, зокрема Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora і Billa.

Переглянути документацію
API доменів 7 Кінцеві точки

Перевірте наявність, встановіть і поновлює домени, а також встановіть сервери назв і автонові.

Переглянути документацію
API DNS 13 Кінцеві точки

Створіть зони DNS і створіть, оновлюйте і вилучіть їх A, AAA, CNAME, MX, TXT, SRV, CAA та інші записи.

Переглянути документацію
API місцезнаходжень 2 Кінцеві точки

Показує список доступних адрес для показу сервера.

Переглянути документацію
Рахунок 1 Кінцеві точки

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

Переглянути документацію
АффіліейтсCity in Germany 7 Кінцеві точки

Витягніть свій афінований баланс, реферали, комісійні та виплати у свій власний звіт, змініть параметри виплат і попросіть виплату.

Переглянути документацію

Більше кінцевих точок

У API також є кінцеві пункти для виконання програм (/ api/ v1/ depoy- configs / і / api/ v1/ depoyments /). Їх ще не описано на цих сторінках; інтерактивні довідкові списки всіх кінцевих точок, створені за допомогою живого API.

Відкрити довідку з програмного інтерфейсу

Потрібна допомога?

Якщо у вас є запитання або вам потрібна допомога з API, будь ласка, не соромтеся звертатися: