VPS.org API

REST API Documentation

VPS.org API Documentation

Zolemba zonse za REST API zoyang'anira ma seva a VPS, ma domain, DNS, zosunga zobwezeretsera, ndi zina zambiri.

Ulalo Woyambira https://admin.vps.org/api/v1
Kutsimikizira Chizindikiro cha Bearer
Chithunzi v1
Kusintha JSON

Kuyambapo

VPS.org API imakulolani kuti muzitha kuyang'anira magawo onse a VPS yanu, kuphatikiza ma seva, ma domain, zolemba za DNS, zosunga zobwezeretsera, ndi zithunzi.

Kutsimikizira

Zopempha zonse za API zimafuna kutsimikizika pogwiritsa ntchito chizindikiro cha Bearer. Mutha kupanga chizindikiro chanu cha API kuchokera ku zokonda za akaunti yanu pa 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);

Token iliyonse imatha kubweretsa ufulu wake, monga servers:list kapena dns: *. Kupempha komwe kumafuna ufulu womwe token siyinakhalepo kumalepheredwa ndi 403 ndi required_permission field yomwe imatchedwa ufulu wosapezeka. Kulemba kwa Malamulo

Kuchepetsa Mitengo

Mafunso ovomerezeka ndi otsika mpaka 1000 pa ola limodzi pa akaunti. Mafunso osavomerezeka ndi otsika mpaka 100 pa ola limodzi pa adiresi ya IP. Mafunso opitilira malire amalandira 429 ndi Retry-After header kupatsa magulu a masekondi kuti ayembekezere. Palibe malire a malire omwe amatumizidwa pa mayankho opambana.

Kusintha

List endpoints kubwezera chinthu ndi kuwerengedwa, kutsatira, zoyambirira ndi zotsatira, 25 zinthu patsamba. Pass page kunyamula pakati pa masamba, kapena kutsatira kutsatira URL mpaka null. The servers mndanso amavomereza page_size, mpaka 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Kukonza Zolakwika

API imagwiritsa ntchito ma code a HTTP status standard kuti iwonetse kupambana kapena kulephera:

Khodi ya Udindo Kufotokozera
200 Kupambana - Pempho latha bwino
201 Zapangidwa - Zinthu zapangidwa bwino
400 Pempho Loipa - Ma parameter olakwika kapena pempho lolakwika
202, 204 Avomerezedwa ndi kutsatira mzere (202), kapena fufutidwa popanda yankho thupi (204)
402 Kulipira Kufunika: palibe njira yolipira pa fayilo, invoices osalipira, kapena kukana katundu pre-authorization
403 Osaloledwa: token siyipezeka, siyigwira ntchito kapena yatha nthawi yake, kapena ilibe ufulu wofunikira. Kulephera kutsimikiziranso kumabweretsa 403, si 401.
404 Sizipezeka - Chida chothandizira sichikupezeka
409 Kutsutsana: mwachitsanzo, kusintha kwa kukula kwakale kale, sichoncho, kapena kukhazikitsa kale
429 Zopempha Zambiri - Malire a mlingo adutsa
500 Cholakwika cha Mkati mwa Seva - Chinachake chalakwika kumbali yathu
503 Service Unavailable: nthawi yaitali vuto. Retry, honouring Retry-After pamene ndi kutumizidwa.

Mavuto a thupi ndi JSON. Ambiri ali ndi deta nyanja kapena nyanja ya vuto, nthawi zina ndi uthenga; kutsimikizika zolakwika limati mavuto ndi dzina la nyanja.

Magulu a API

Sakatulani zolemba zathu za API motsatira gulu:

API ya Ma seva 15 Mapeto

Kukhazikitsa, kuyesa, mphamvu, kusintha ndi kuchotsa ma seva, kubwezeretsa mawu achinsinsi a root, kukhazikitsa DNS yosinthika, kuyendetsa malamulo, ndi kuyendetsa ma SSH.

Onani Zolemba
API Yosungira Zinthu Zosungidwa 4 Mapeto

Lipoti la zidziwitso zanu za server, kuyamba kubwezeretsa kwatsopano, ndi kubwezeretsa server kuchokera ku backup.

Onani Zolemba
Zithunzi Zazing'ono API 4 Mapeto

Take labelled snapshots wa seva, mnda wawo ndi kuwachotsa.

Onani Zolemba
Mapulani API 2 Mapeto

Pezani mapulani a VPS omwe alipo komanso zambiri zokhudza mitengo. Pezani zambiri zokhudza zinthu, mitengo, ndi kupezeka.

Onani Zolemba
API ya Machitidwe Ogwirira Ntchito 2 Mapeto

Limbikitsani machitidwe ndi mitundu yomwe mungayike, monga Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora ndi Alpine.

Onani Zolemba
Ma domains API 7 Mapeto

Pezani zopezeka, kulembetsa ndi kubwezeretsa ma domains, ndikukhazikitsa ma servers a dzina ndi kubwezeretsa kwaotomatiki.

Onani Zolemba
DNS API 13 Mapeto

Kukhazikitsa DNS zomera ndi kulenga, kusinthira ndi kuchotsa awo A, A, CNAME, MX, TXT, SRV, CAA ndi zina zolemba.

Onani Zolemba
API ya Malo 2 Mapeto

List malo opezeka kwa server kukhazikitsa.

Onani Zolemba
Akaunti 1 Mapeto

Kupeza akaunti ya akaunti ndi API token information. Identify yomwe akaunti ya token ili ndi kufunsa zilolezo zake.

Onani Zolemba
Ogwirizana 7 Mapeto

Sungani ndalama zanu za affiliate, zolemba, ndalama ndi ndalama m'mabuku anu, sinthanize ndalama ndi ndalama zofunsira.

Onani Zolemba

Zomwe zimachitika

API alinso endpoints kwa app kukhazikitsa (/api/v1/deploy-configs/ ndi /api/v1/deployments/). Iwo si anafotokoza pa izi masamba panopa; interaction reference limati limapereka zonse endpoints, analenga kuchokera ku moyo API.

Kutsegula interaction API reference

Mukufuna Thandizo?

Ngati muli ndi mafunso kapena mukufuna thandizo ndi API, musazengereze kulankhulana nafe: