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

Първи стъпки

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

Удостоверяване

Всички API заявки изискват удостоверяване с помощта на Bearer token. Можете да генерирате вашия API token от настройките на вашия акаунт на admin.vps.org/account/developers/.

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);

Всеки жетон носи собствените си права, като например сървъри:list или dns:*. Запитване, което се нуждае от разрешение, което не е има, е отказано с 403 и изисквано_ за задържане полето, на което се казва липсващото разрешение. Референтна информация за правата

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

Автентифицираните заявки са ограничени до 1000 на час на сметка. Неаутентичните искания са ограничени до 100 на час на IP адрес. Заявка над границата получава 429 с заглавък Повтори-Афтър, който дава броя на секундите да чакаме. Не се изпращат ограничаващи заглавни точки при успешни отговори.

Пъхване

Списък на крайните точки се връща обект с броене, следващ, предишни и резултати, 25 елементи на страница. Пропускайте страницата, за да се движи между страниците, или следвайте следващия URL, докато не е null. Списъкът на сървърите също приема page_size, до 100.

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

Обработка на грешки

API използва стандартни HTTP кодове за състояние, за да покаже успех или неуспех:

Телата на грешките са JSON. Повечето имат поле за подробности или грешка, понякога с съобщение; грешките за валидиране изброяват проблемите по име на полето.

Категории на API

Разгледайте нашата API документация по категории:

Още крайни точки

API също така има крайни точки за разгръщане на приложения (/api/v1/deploploy-configs/ и /api/v1/deplayments /). Те все още не са описани на тези страници; интерактивната референтна таблица на всеки крайен крайен изход, генериран от живо API.

Нуждаете се от помощ?

Ако имате въпроси или се нуждаете от помощ с API, не се колебайте да се свържете с нас:

• Заявки за поддръжка: Отворете заявка за поддръжка
• Имейл: hello@vps.org
• Документация: Пълна документация