VPS.org API

Дакументацыя REST API

Дакументацыя API VPS.org

Поўная дакументацыя па REST API для кіравання VPS-серверамі, даменамі, DNS, рэзервовым капіраваннем і многім іншым.

Базавы URL-адрас https://admin.vps.org/api/v1
Аўтэнтыфікацыя Токен на прад'яўніка
Версія v1.0
Фармат JSON

Пачатак працы

API VPS.org дазваляе праграмна кіраваць усімі аспектамі вашай інфраструктуры VPS-хостынгу, уключаючы серверы, дамены, DNS-запісы, рэзервовыя копіі і здымкі.

Аўтэнтыфікацыя

Усе запыты API патрабуюць аўтэнтыфікацыі з выкарыстаннем токена-носьбіта. Вы можаце стварыць свой токен 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 абмежаваныя 300 запытамі за 5 хвілін на адзін токен API. Інфармацыя аб абмежаванні хуткасці ўключана ў загалоўкі адказу:

Апрацоўка памылак

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.

Праглядзець дакументацыю
API DNS 4 канчатковыя кропкі

Кіруйце DNS-зонамі і запісамі праграмна. Стварэнне, абнаўленне і выдаленне запісаў тыпаў A, AAAA, CNAME, MX, TXT і іншых.

Праглядзець дакументацыю
API месцазнаходжанняў 1 канчатковая кропка

Спіс даступных месцаў разгортвання цэнтраў апрацоўкі дадзеных. Выбірайце з некалькіх рэгіёнаў па ўсім свеце.

Праглядзець дакументацыю

Патрэбна дапамога?

Калі ў вас ёсць пытанні ці вам патрэбна дапамога з API, калі ласка, не саромейцеся звяртацца: