VPS.org API

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

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

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

Негізгі 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);

Әрбір токен өзінің рұқсаттарын сақтайды, мысалы servers: list не dns: *. Токенге рұқсат керек болса, ол рұқсат жоқ дегенді көрсететін required_ permission өрісімен 403 дегенді көрсетіп, рұқсат жоқ дегенді көрсететін өріспен қайтарылады. Рұқсаттар сілтемесі

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

Аутентификацияланған сұраныстардың саны бір тіркелгі үшін сағатына 1000- ге шектеледі. Аутентификацияланбаған сұраныстардың саны бір IP адресі үшін сағатына 100- ге шектеледі. Шектеуден асқан сұраныс 429 деп есептеледі, күту уақыты секундтармен көрсетілген Retry- After айдарымен. Сәтті жауаптар үшін жылдамдық шегі айдары жіберілмейді.

Беттеу

Тізімнің соңы сан, келесі, алдыңғы және нәтижелермен, беттегі 25 нысанмен қайтарылады. Беттер арасында жылжу үшін бетті өткізіп жіберіңіз, немесе нөлге дейін келесі URL- ді орындаңыз. Серверлер тізімі page_ size дегенді де қабылдайды, 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 Тыйым салынған: Токен жоқ, жарамсыз, мерзімі өткен, немесе қажетті рұқсаты жоқ. Аутентификацияның жаңылысы 401 емес, 403 дегенді қайтарады.
404 Табылмады - Ресурс жоқ
409 Қайшылық: мысалы, өлшемін өзгерту әлі жүріп жатыр, сыйымдылығы жеткіліксіз, немесе орналастыру әлі жүріп жатыр
429 Тым көп сұраныс - жылдамдық шегінен асып кетті
500 Ішкі сервер қатесі - Біздің тарапымыздан бірдеңе дұрыс болмады
503 Қызмет қол жеткізбейді: уақытша мәселе. Қайталап көріңіз, жіберілгенде Retry- After дегенді орындаңыз.

Қателер JSON түрінде беріледі. Көбінесе егжей- тегжейі немесе қате өрісі, кейде хабарлама бар; тексеру қателері өріс атауы бойынша келтіріледі.

API санаттары

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

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

Серверлерді құру, тексеру, қуаттандыру, өлшемін өзгерту және өшіру, root паролін қалпына келтіру, кері DNS орнату, командаларды орындау және SSH кілттерімен жұмыс істеу.

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

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

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

Сервердің атауымен суреттерді түсіру, оларды тізімдеу және өшіру.

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

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

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

Орындауға болатын операциялық жүйелер мен нұсқалар тізімі, мысалы Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora және Alpine.

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

Барлығын тексеру, домендер тіркеу мен жаңарту, атау серверлерін орнату және автоматты жаңарту.

Құжаттаманы қарау
DNS API 13 Соңғы нүктелер

DNS аймақтарды құрып, олардың A, A, CNAME, MX, TXT, SRV, CAA және басқа жазуларын құрып, жаңартып, өшіру.

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

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

Құжаттаманы қарау
Тіркелгі 1 Соңғы нүктелер

Тіркелгі профилі мен API токен мәліметін алу. Токеннің қай тіркелгінің меншігі екенін анықтап, оның рұқсаттарын тексеру.

Құжаттаманы қарау
Қосылғандар 7 Соңғы нүктелер

Сіздің серіктес балансыңызды, ұсыныстарыңызды, комиссияларыңыз бен төлемдеріңізді өз есептік жазбаңызға шығарып, төлем параметрлерін өзгертіп, төлемдерді сұраңыз.

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

Қосымша аяқтау нүктелері

API- нің қосымшаны орналастыру үшін де аяқтау нүктелері бар (/ api/ v1/ deploy- configs / және / api/ v1/ deployments /). Олар осы парақтарда әлі сипатталмаған; интерактивті сілтемеде тірі API- дан жасалған әрбір аяқтау нүктесі көрсетілген.

Интерактивті API сілтемесін ашу

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

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