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

Баштоо

VPS.org API сизге VPS хостинг инфраструктураңыздын бардык аспектилерин, анын ичинде серверлерди, домендерди, DNS жазууларын, камдык көчүрмөлөрдү жана сүрөттөрдү программалык түрдө башкарууга мүмкүндүк берет.

Аутентификация

Бардык API сурамдары Bearer токенин колдонуу менен аутентификацияны талап кылат. Сиз API токениңизди аккаунтуңуздун жөндөөлөрүнөн түзө аласыз. 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);

Каждый токен имеет свои собственные права, например servers:list или dns:*. Если требуется разрешение, которое нет у токена, то запрос отклоняется с помощью 403 и required_permission поля, в котором указывается отсутствующее разрешение. Укуктар

Бааны чектөө

Аутентификацияланган суроолор бир эсепке саатына 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 абал коддорун колдонот:

Каталардын денеси JSON форматында. Көбүнчө, маалыматтар же ката талаасы бар, кээде кабар менен; текшерүү каталары маселелерди талаа аты боюнча тизмелейт.

API категориялары

API документтерибизди категория боюнча карап чыгыңыз:

Көбүрөөк аяктоо пункттары

API ошондой эле колдонмонун жайгаштырылышы үчүн аяктоо пункттарын (/api/v1/deploy-configs/ жана /api/v1/deployments/) камтыйт. Алар бул баракчаларда азырынча баяндалбаган; интерактивдүү шилтемеде ар бир аяктоо пункту, Live API'дан түзүлгөн, тизмеленет.

Жардам керекпи?

Эгерде сизде суроолор болсо же API боюнча жардам керек болсо, биз менен байланышуудан тартынбаңыз:

• Колдоо билеттери: Колдоо билетин ачыңыз
• Электрондук почта: hello@vps.org
• Документация: Толук документтештирүү