Išsami REST API dokumentacija, skirta VPS serverių, domenų, DNS, atsarginių kopijų ir kitų dalykų valdymui.
„VPS.org“ API leidžia programiškai valdyti visus VPS talpinimo infrastruktūros aspektus, įskaitant serverius, domenus, DNS įrašus, atsargines kopijas ir momentines kopijas.
Visoms API užklausoms reikalingas autentifikavimas naudojant „Bearer“ prieigos raktą. API prieigos raktą galite sugeneruoti savo paskyros nustatymuose adresu 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);Kiekvienas žetonas turi savo leidimus, pavyzdžiui, serverių:list arba dns:*. Prašymas, kuris turi leidimą žetonas nėra atmesta su 403 ir reikalaujama_atleidimas laukas pavadinti trūkstamas leidimo. Leidimų nuoroda
Authenticated requests are limited to 1,000 per hour per account. Unauthenticated requests are limited to 100 per hour per IP address. A request over the limit receives 429 with a Retry-After header giving the number of seconds to wait. No rate limit headers are sent on successful responses.
Sąrašas Galutiniai rodikliai grąžinti objektą su skaičiumi, kitu, ankstesniu ir rezultatais, 25 elementais per puslapį. Pereiti puslapį, kad pereitumėte tarp puslapių, arba sekti kitą URL, kol jis bus nulinis. Serverių sąrašas taip pat priima puslapio_ dydį, iki 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}API naudoja standartinius HTTP būsenos kodus, kad parodytų sėkmę arba nesėkmę:
| Būsenos kodas | Aprašymas |
|---|---|
200 |
Sėkmė – užklausa sėkmingai įvykdyta |
201 |
Sukurta – išteklius sėkmingai sukurtas |
400 |
Neteisinga užklausa – neteisingi parametrai arba netinkamai suformuota užklausa |
202, 204 |
Priimtas ir įrašytas į eilę (202) arba ištrintas be atsako įstaigos (204) |
402 |
Mokėjimas Reikalingas: nėra mokėjimo būdo byloje, nesumokėtos sąskaitos faktūros, arba atmestas kortelės išankstinis leidimas |
403 |
Draudžiama: simbolis yra trūkstamas, negalioja ar pasibaigė, arba trūksta reikiamo leidimo. Nepavykos autentifikavimas taip pat grąžinamas 403, o ne 401. |
404 |
Nerasta – išteklių nėra |
409 |
Konfliktas: pavyzdžiui, jau vykdomas permainų, nepakankamų pajėgumų ar jau vykdomos diegimo |
429 |
Per daug užklausų – viršytas dažnio limitas |
500 |
Vidinė serverio klaida – kažkas nutiko mūsų pusėje |
503 |
Paslauga nepasiekiama: laikina problema. Bandyti vėl, gerbti vėl-Po, kai ji yra siunčiama. |
Klaidų įstaigos yra JSON. Dauguma turi detalių lauką arba klaidų lauką, kartais su pranešimu; patvirtinimo klaidos sąrašą problemas pagal lauko pavadinimą.
Naršykite mūsų API dokumentaciją pagal kategoriją:
Sukurti, tikrinti, galia, keisti dydį ir panaikinti serverius, iš naujo nustatyti šaknų slaptažodį, nustatyti atvirkštinį DNS, paleisti komandas, ir valdyti SSH klavišus.
Peržiūrėti dokumentacijąIšvardykite serverio atsargines kopijas, paleiskite naują atsarginę kopiją ir atkurkite serverį iš atsarginių kopijų.
Peržiūrėti dokumentacijąImkite pažymėtus serverio vaizdajuostes, jas išvardykite ir ištrinkite.
Peržiūrėti dokumentacijąGaukite galimus VPS planus ir kainodaros informaciją. Gaukite išsamią informaciją apie išteklius, kainas ir prieinamumą.
Peržiūrėti dokumentacijąIšvardykite operacines sistemas ir versijas, kurias galite įdiegti, pvz., Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora ir Alpine.
Peržiūrėti dokumentacijąPatikrinkite, ar yra duomenų, registruokitės ir atnaujinkite domenus, nustatykite vardų serverius ir automatinius atnaujinimus.
Peržiūrėti dokumentacijąSukurti DNS zonas ir sukurti, atnaujinti ir ištrinti jų A, A, CNAME, MX, TXT, SRV, CAA ir kiti įrašai.
Peržiūrėti dokumentacijąIšvardykite vietas, kurias galima įdiegti serveriui.
Peržiūrėti dokumentacijąGauti paskyros profilį ir API simbolinę informaciją. Nustatyti, kuri sąskaita simbolis priklauso ir patikrinti jos leidimus.
Peržiūrėti dokumentacijąPatraukite savo filialo balansą, kreipimosi, komisiniai ir išmokos į savo ataskaitą, pakeisti išmokėjimo nustatymus ir prašyti išmokėjimo.
Peržiūrėti dokumentacijąAPI taip pat turi programos diegimo (/api/v1/ depliation-configs/ and /api/v1/ sesions/) rezultatų. Jie dar neaprašyti šiuose puslapiuose; interaktyvių nuorodų sąrašai kiekvienai iš rezultatų, sukurtų iš gyvų API.
Atverti interaktyvią API nuorodąJei turite klausimų arba jums reikia pagalbos dėl API, nedvejodami kreipkitės: