Pilnīga REST API dokumentācija VPS serveru, domēnu, DNS, dublējumu un citu lietu pārvaldībai.
VPS.org API ļauj programmatiski pārvaldīt visus jūsu VPS mitināšanas infrastruktūras aspektus, tostarp serverus, domēnus, DNS ierakstus, dublējumkopijas un momentuzņēmumus.
Visiem API pieprasījumiem ir nepieciešama autentifikācija, izmantojot nesēja žetonu. Jūs varat ģenerēt savu API žetonu sava konta iestatījumos vietnē 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);Katrs žetons veic savas atļaujas, piemēram, serveri:list vai dns:*. Pieprasījums, kas nepieciešams atļauju žetons nav noraidīts ar 403 un prasīts_atļaujas lauks nosaukt trūkstošo atļauju. Atļauju atsauce
Autentificēti pieprasījumi nepārsniedz 1000 par stundu kontā. Neautentificēti pieprasījumi nepārsniedz 100 par stundu par IP adresi. Pieprasījums par ierobežojumu saņem 429 ar Retrie-Pēc galvenes, kas dod sekundes gaidāmo. Pēc veiksmīgām atbildēm nav nosūtītas likmes limita galvenes.
Saraksts galarezultātu atgriezt objektu ar skaitu, nākamo, iepriekšējo un rezultātu, 25 vienumus lapā. Lai pārvietotos starp lapām, caurlaides lapa vai sekot nākamajam URL, līdz tas ir nulle. Serveru saraksts arī pieņem lapas_ izmēru, līdz 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}API izmanto standarta HTTP statusa kodus, lai norādītu uz panākumiem vai neizdošanos:
| Statusa kods | Apraksts |
|---|---|
200 |
Veiksmīgi — pieprasījums veiksmīgi izpildīts |
201 |
Izveidots — resurss veiksmīgi izveidots |
400 |
Nederīgs pieprasījums — nederīgi parametri vai nepareizi veidots pieprasījums |
202, 204 |
Pieņemts un rindā (202) vai svītrots bez atbildes struktūras (204) |
402 |
Maksājums nepieciešams: nav maksājuma metodes par failu, neapmaksāti rēķini, vai atteikta kartes pirms atļaujas |
403 |
Aizliegts: atzīme ir trūkstoša, nederīga vai tai beidzies derīguma termiņš, vai arī nav nepieciešamās atļaujas. Neizdevās autentificēt arī 403, ne 401. |
404 |
Nav atrasts — resurss nepastāv |
409 |
Konflikts: piemēram, jau notiek pārmaiņas, nav pietiekamas jaudas vai izvēršana jau notiek |
429 |
Pārāk daudz pieprasījumu — pārsniegts ātruma ierobežojums |
500 |
Iekšēja servera kļūda — mūsu pusē radās problēma. |
503 |
Pakalpojums nav pieejams: pagaidu problēma. Atkal, godinot Retrie-Pēc, kad tas ir nosūtīts. |
Kļūdas iestādes ir JSON. Vairumam ir detaļas lauks vai kļūdu lauks, dažreiz ar ziņojumu; apstiprināšanas kļūdas norāda problēmas pēc lauka nosaukuma.
Pārlūkojiet mūsu API dokumentāciju pēc kategorijas:
Izveidot, pārbaudīt, jauda, mainīt izmēru un dzēst serveri, atjaunot saknes paroli, uzstādīt reverso DNS, palaist komandas, un pārvaldīt SSH taustiņus.
Skatīt dokumentācijuParādiet servera rezerves kopijas, palaidiet jaunu rezerves kopiju un no rezerves servera atjaunojiet rezerves kopiju.
Skatīt dokumentācijuVeikt iezīmētus servera momentuzņēmumus, tos sarakstu un dzēst.
Skatīt dokumentācijuIegūt pieejamos VPS plānus un cenu informāciju. Iegūt informāciju par resursiem, cenām un pieejamību.
Skatīt dokumentācijuUzskaitiet operētājsistēmas un versijas, kuras varat uzstādīt, piemēram, Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora un Alpine.
Skatīt dokumentācijuPārbaudiet pieejamību, reģistrē un atjauno domēnus, un uzstādīt nosaukumuserveri un auto-atjaunošanu.
Skatīt dokumentācijuIzveidot DNS zonas un izveidot, atjaunināt un dzēst to A, A, CNAME, MX, TXT, SRV, CAA un citi ieraksti.
Skatīt dokumentācijuUzskaitīt vietas, kas pieejamas servera izvēršanai.
Skatīt dokumentācijuIegūst konta profilu un API simbolisku informāciju. Identificējiet, kurš konts pieder pie žetona un pārbaudiet tā atļaujas.
Skatīt dokumentācijuPull jūsu filiāles bilanci, liecības, komisijas un izmaksas jūsu pašu ziņojumu, mainīt izmaksu iestatījumus un pieprasīt izmaksu.
Skatīt dokumentācijuAPI ir arī galapunkti aplikāciju izvēršanai (/api/v1/ izlikšanai- konfigācijām/ un /api/v1/ izvietojumiem/). Tie vēl nav aprakstīti šajās lapās; interaktīvie atsauces saraksti katram mērķa kritērijam, kas radies no dzīvās API.
Atvērt interaktīvo API atsauciJa jums ir jautājumi vai nepieciešama palīdzība ar API, lūdzu, nevilcinieties sazināties ar mums: