VPS.org API

REST API құжаттамасы

VPS.org API құжаттамасы

VPS серверлерін, домендерді, DNS, сақтық көшірмелерді және т.б. басқаруға арналған толық REST API құжаттамасы.

Негізгі URL мекенжайы https://admin.vps.org/api/v1
Аутентификация Тасымалдаушы токені
Нұсқа v1.0
Пішімдеу 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);

Бағамды шектеу

API сұраулары әрбір API токені үшін 5 минут ішінде 300 сұраумен шектеледі. Жылдамдық шегі туралы ақпарат жауап тақырыптарында көрсетілген:

Қателерді өңдеу

API сәттілікті немесе сәтсіздікті көрсету үшін стандартты HTTP күй кодтарын пайдаланады:

Күй коды Сипаттама
200 Сәтті аяқталды - Сұраныс сәтті аяқталды
201 Құрылды - Ресурс сәтті жасалды
400 Қате сұрау - Жарамсыз параметрлер немесе дұрыс емес сұрау
401 Рұқсат етілмеген - Жарамсыз немесе жоқ аутентификация токені
403 Тыйым салынған - Рұқсаттар жеткіліксіз
404 Табылмады - Ресурс жоқ
429 Тым көп сұраныс - жылдамдық шегінен асып кетті
500 Ішкі сервер қатесі - Біздің тарапымыздан бірдеңе дұрыс болмады

API санаттары

Біздің API құжаттамамызды санат бойынша шолыңыз:

Серверлер API 9 соңғы нүкте

VPS серверлерін жасау, басқару және бақылау. Қуатты басқаруды, өлшемін өзгертуді, қайта орнатуды және сервер ақпаратын алуды қамтиды.

Құжаттаманы қарау
Сақтық көшірмелер API 3 соңғы нүкте

Серверлеріңіз үшін автоматтандырылған және қолмен жасалған сақтық көшірмелерді басқарыңыз. Сервер сақтық көшірмелерін тізімдеңіз, жасаңыз, қалпына келтіріңіз және жойыңыз.

Құжаттаманы қарау
Суреттер API интерфейсі 4 соңғы нүкте

Жылдам қалпына келтіру нүктелері үшін сервер суреттерін жасаңыз және басқарыңыз. Тестілеу және жылдам қайтару үшін өте қолайлы.

Құжаттаманы қарау
Жоспарлар API 2 соңғы нүкте

Қолжетімді VPS жоспарлары мен бағалары туралы ақпаратты алыңыз. Ресурстар, бағалар және қолжетімділік туралы толық ақпарат алыңыз.

Құжаттаманы қарау
Операциялық жүйелер API 2 соңғы нүкте

Серверді орналастыруға арналған қолжетімді операциялық жүйелер мен кескіндердің тізімін жасаңыз. Ubuntu, Debian, CentOS және т.б. қамтиды.

Құжаттаманы қарау
Домендер API 6 соңғы нүкте

Домен атауларын іздеңіз, қолжетімділігін тексеріңіз, тіркеңіз және басқарыңыз. API арқылы доменнің өмірлік циклін толық басқарыңыз.

Құжаттаманы қарау
DNS API 4 соңғы нүкте

DNS аймақтары мен жазбаларын бағдарламалық түрде басқарыңыз. A, AAAA, CNAME, MX, TXT және басқа жазба түрлерін жасаңыз, жаңартыңыз және жойыңыз.

Құжаттаманы қарау
Орналасқан жерлердің API интерфейсі 1 соңғы нүкте

Серверді орналастыру үшін қолжетімді деректер орталығының орындарын тізімдеңіз. Әлем бойынша бірнеше аймақтан таңдаңыз.

Құжаттаманы қарау

Көмек керек пе?

Егер сізде сұрақтар туындаса немесе API бойынша көмек қажет болса, хабарласудан тартынбаңыз: