VPS.org API

REST API ҳужжатлаштириш

VPS.org API ҳужжатлаштириш

VPS serverlari, domenlari, DNS, zaxira nusxalari va boshqalarni boshqarish uchun to'liq REST API hujjatlari.

Asosiy URL https://admin.vps.org/api/v1
Autentifikatsiya Tashuvchi Token
Версия v1
Форматлаш JSON

Ishni boshlash

VPS.org API sizga VPS xosting infratuzilmasining barcha jihatlarini, jumladan, serverlar, domenlar, DNS yozuvlari, zaxira nusxalari va suratlarni dasturiy ravishda boshqarish imkonini beradi.

Autentifikatsiya

Barcha API so'rovlari Bearer tokenidan foydalangan holda autentifikatsiyani talab qiladi. Siz API tokeningizni hisob sozlamalaringizdan quyidagi manzilda yaratishingiz mumkin 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:*, олиб юради. Токенга рухсат керак бўлган илтимос, 403 ва йўқолган рухсатни атаган required_permission майдони билан рад этилади. Ҳуқуқлар манбаси

Stavkalarni cheklash

Аутентификация қилинган талаблар ҳар бир ҳисоб учун соатига 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": [ ... ]
}

Xatolarni boshqarish

API muvaffaqiyat yoki muvaffaqiyatsizlikni ko'rsatish uchun standart HTTP holat kodlaridan foydalanadi:

Holat kodi Тасвирлаш
200 Muvaffaqiyatli - So'rov muvaffaqiyatli bajarildi
201 Yaratilgan - Resurs muvaffaqiyatli yaratildi
400 Noto'g'ri so'rov - Noto'g'ri parametrlar yoki noto'g'ri tuzilgan so'rov
202, 204 Қўлланган ва навбатга қўйилган (202), ёки жавобсиз тана билан ўчирилган (204)
402 Тўлов талаб этилади: файлда тўлов усули йўқ, тўловсиз ҳисобварақ ёки рад этилган карта олдиндан рухсат бериш
403 Тақиқланган: токен йўқ, ноқонуний ёки муддати ўтган ёки талаб қилинган рухсат йўқ. Аутентификация муваффақиятсиз бўлганида ҳам 401 эмас, 403 қайтарилади.
404 Topilmadi - Resurs mavjud emas
409 зиддият: масалан, катта-кичиклигини ўзгартириш жараёни кетаётир, етарли қувват йўқ ёки тарқатиш ишлари кетаётир
429 Juda ko'p so'rovlar - Narx chegarasidan oshib ketdi
500 Ichki server xatosi - Biz tomonda nimadir noto'g'ri ketdi
503 Хизмат йўқ: вақтинчалик муаммо. Қайта уриниш, юборилганда Retry-After ҳурмат қилинади.

Хатолар таркиби JSON. Кўпчилигида маълумот майдони ёки хато майдони бор, баъзан хабар билан; текшириш хатолари муаммоларни майдон номи бўйича рўйхатга олади.

API kategoriyalari

API hujjatlarimizni kategoriya bo'yicha ko'rib chiqing:

Serverlar APIsi 15 Tugash nuqtalari

Серверларни яратиш, текшириш, қувватлаш, ўлчамларини ўзгартириш ва ўчириб ташлаш, root махфий сўзини қайта ўрнатиш, акси DNS ўрнатиш, буйруқларни бажариш ва SSH қулфларини бошқариш.

Hujjatlarni ko'rish
Zaxira nusxalari APIsi 4 Tugash nuqtalari

Сервернинг заҳира нусхаларини рўйхатга олиш, янги заҳирани бошлаш ва серверни заҳирадан тиклаш.

Hujjatlarni ko'rish
Snapshots API'si 4 Tugash nuqtalari

Сервернинг белгиланган суратларини олинг, уларни рўйхатга олинг ва уларни ўчиринг.

Hujjatlarni ko'rish
Rejalar APIsi 2 Tugash nuqtalari

Mavjud VPS rejalari va narxlar haqida ma'lumot oling. Resurslar, narxlar va mavjudligi haqida ma'lumot oling.

Hujjatlarni ko'rish
Operatsion tizimlar APIsi 2 Tugash nuqtalari

Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora ва Alpine каби ўрнатишингиз мумкин бўлган операцион тизимлар ва версияларни рўйхатга олади.

Hujjatlarni ko'rish
Доменлар API 7 Tugash nuqtalari

Доменлар мавжудлигини текширинг, доменларни рўйхатдан ўтказинг ва янгиланг, ном серверларини ва автоматик янгиланишни ўрнатинг.

Hujjatlarni ko'rish
DNS API 13 Tugash nuqtalari

DNS зоналарини яратинг ва уларнинг A, A, CNAME, MX, TXT, SRV, CAA ва бошқа ёзувларни яратинг, янгиланг ва ўчиринг.

Hujjatlarni ko'rish
Joylashuvlar APIsi 2 Tugash nuqtalari

Серверни ўрнатиш учун мавжуд жойлар рўйхатини кўрсатинг.

Hujjatlarni ko'rish
Ҳисоб 1 Tugash nuqtalari

Ҳисоб профили ва API токен маълумотларини олиш. Токен қайси ҳисобга тегишли эканлигини аниқлаш ва унинг рухсатларини текшириш.

Hujjatlarni ko'rish
Алоқадорлар 7 Tugash nuqtalari

Ўзингизнинг филиал балансингизни, тавсияларингизни, комиссияларингизни ва тўловларни ўз ҳисоботингизга олиб чиқинг, тўлов параметрларини ўзгартиринг ва тўловларни сўранг.

Hujjatlarni ko'rish

Кўпроқ охири

API дастурни ўрнатиш учун ҳам охирги нуқталарга эга (/api/v1/deploy-configs/ ва /api/v1/deployments/). Улар бу саҳифаларда ҳали тасвирланмаган; интерактив манба ҳар бир охирги нуқтани рўйхатга олади, бу API дан яратилган.

Интерактив API манбасини очиш

Yordam kerakmi?

Agar sizda savollar bo'lsa yoki API bo'yicha yordam kerak bo'lsa, iltimos, biz bilan bog'lanishdan tortinmang: