VPS.org API

Документация REST API

VPS.org API Документация

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

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

Начиная

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

Аутентификация

Для всех запросов к API требуется аутентификация с использованием токена Bearer. Вы можете сгенерировать свой 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);

Каждый токен имеет свои собственные разрешения, такие как серверы: список или Dn:*. Запрос, который нуждается в разрешении, не имеет разрешения, отклоняется с 403 и требуемым_пропуском, на котором пропущено разрешение. Ссылка на разрешения

Ограничение скорости

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

Увлечения

Список конечных точек возвращает объект со счетом, следующим, предыдущим и результатами, 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 и Alpine.

Просмотреть документацию
Домена API 7 Конечные точки

Проверьте наличие, регистрируйте и обновляйте домена, а также назначьте серверы и обновьте их.

Просмотреть документацию
ОДИН 13 Конечные точки

Создание зон DNS и создание, обновление и удаление их A, A, CNAME, MX, TXT, SRV, CAA и других записей.

Просмотреть документацию
API местоположений 2 Конечные точки

Перечислите места, где можно разместить сервер.

Просмотреть документацию
Счет 1 Конечные точки

Найдите профиль счета и токен-информацию API. Выявите, какой счет принадлежит, и проверьте его разрешения.

Просмотреть документацию
Аффилированные 7 Конечные точки

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

Просмотреть документацию

Более конечные

АПИ также имеет конечных точек для развертывания приложений (/api/v1/deploy-configs/ и/api/v1/downments/), которые пока не описаны на этих страницах; интерактивные справочные перечни всех конечных точек, составленные на основе живого АПИ.

Откройте интерактивный справочный API

Нужна помощь?

Если у вас возникнут вопросы или потребуется помощь с API, пожалуйста, не стесняйтесь обращаться к нам: