VPS.org API

РЕСТЕПНА АПИ документација

VPS.org АПИ документација

Комплетна REST API документација за управљање VPS серверима, доменима, DNS-ом, резервним копијама и још много тога.

Основни URL https://admin.vps.org/api/v1
Аутентификација Токен носиоца
Верзија v1
Формат JSON

Почетак рада

VPS.org API вам омогућава да програмски управљате свим аспектима ваше 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);

Сваки жетон носи своје дозволе, као што су сервери:list или dns: *. Захт› јев који захтева дозволу за жетон који није захт› ијеван одбијен је са 403 и неопходним пољем за прилазу које имењује недостајућу дозволу. референца дозвола

Ограничавање брзине

Аутентификовани захт› јеви су ограничени на 1.000 по сату по налогу. Неаутентификовани захт› јеви су ограничени на 100 по сату по ИП адреси. Захт› јев преко границе прима 429 са заглављем „ Понављање после “ којим се чека број секунди. На успешном одговору не шаље се ограничења стапке.

Пагирање

Исходни крајеви списка враћају објект са бројем, следећим, претходним и резултатима, 25 ставки по страници. Додај страницу да се помера између страница, или прати следећи УРЛ док не буде нулти. Списак сервера прихвата и страницу_ величину, до 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 Сервис недоступан: привремени проблем. Понављам, почастивањем понављања по слању.

Тела грешака су ЈСОН. Већина има поље детаља или поље грешке, понекад са поруком; грешка у овлашћењу набраја проблеме по имену поља.

Категорије API-ја

Прегледајте нашу API документацију по категоријама:

API сервера 15 Крајње тачке

Стварање, инспектирање, напајање, пром› јена величине и брисање сервера, ресетирање корене лозинке, постављање обрнутог ДНС‐ а, покретање наредби и управљање СХ кључевима.

Погледајте документацију
API за резервне копије 4 Крајње тачке

Наброји резерве сервера, покрени нову резерву и врати сервер из резерве.

Погледајте документацију
API за снимке 4 Крајње тачке

Узми означене снимке сервера, наброји их и обриши их.

Погледајте документацију
API за планове 2 Крајње тачке

Преузмите доступне VPS планове и информације о ценама. Добијте детаље о ресурсима, ценама и доступности.

Погледајте документацију
API оперативних система 2 Крајње тачке

Наброји операционе системе и верзије које можете инсталирати, као што су Убунут, Дебиан, Роки Линукс, Центос Стреам, Федора и Алпине.

Погледајте документацију
АПИ домена 7 Крајње тачке

Провери доступност, региструј и обнови домене, и постављај сервере имена и аутоматско обновљивање.

Погледајте документацију
ДНС АПИ 13 Крајње тачке

Направите ДНС зоне и направите, ажурирате и обришите њихове А, А, ЦNAME, MX, TXT, SRV, ЦАА и друге записе.

Погледајте документацију
API за локације 2 Крајње тачке

Наброји локације доступне за постављање сервера.

Погледајте документацију
Налог 1 Крајње тачке

Добављање профила налога и АПИ токена. Одредите ком налогу припада и пров› јерите његове дозволе.

Погледајте документацију
асфилиати 7 Крајње тачке

Увуците свој афилијални баланс, референце, комисије и исплате у сопственом извештавању, промените исплату и захтева исплату.

Погледајте документацију

Више крајњих тачака

АПИ такође има крајње тачке за распоредивање програма (/api/v1/ deploploy- configs/ and / api/ v1/ deploployments /). Они још нису описани на овим страницама; интерактивни референт набраја сваки крајњи крај, генерисан из живог АПИ‐ а.

Отвори интерактивни упућивач АПИ‐ а

Потребна вам је помоћ?

Ако имате питања или вам је потребна помоћ у вези са API-јем, слободно нас контактирајте: