Täielik REST API dokumentatsioon VPS-serverite, domeenide, DNS-i, varukoopiate ja muu haldamiseks.
VPS.org API võimaldab teil programmiliselt hallata kõiki oma VPS-i majutusinfrastruktuuri aspekte, sealhulgas servereid, domeene, DNS-kirjeid, varukoopiaid ja hetktõmmiseid.
Kõik API-päringud vajavad autentimist Bearer tokeni abil. Saate oma API-tokeni genereerida oma konto seadetes aadressil 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);Iga märgil on oma õigused, näiteks serverid:loend või dns:*. Taotlusest, mis vajab luba, mida märgil ei ole, keeldutakse 403 ja puuduvale loale on märgitud nõutav_luba. Õiguste viide
Autentsed päringud on piiratud 1000- ga tunnis konto kohta. Autendimata päringud on piiratud 100- ga tunnis IP- aadressi kohta. Piirmäära ületav päring saab 429 päringuga "Retry- Packow" päise, mis annab ootamiseks aega sekundite arvu. Eduka vastuse korral ei saada määrapiirangupäiseid.
Nimekiri lõpp- udendid tagasta objekt järgneva, eelmise ja tulemusega 25 elementi lehekülje kohta. Mine leheküljele, et liikuda lehekülgede vahel või järgi järgmist URL- i kuni see on null. Serverite nimekiri võtab vastu ka lehekülje _ suuruse, kuni 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}API kasutab edu või ebaõnnestumise näitamiseks standardseid HTTP olekukoode:
| Staatuse kood | Description |
|---|---|
200 |
Edu – päring edukalt täidetud |
201 |
Loodud – ressurss loodud edukalt |
400 |
Vigane päring – sobimatud parameetrid või valesti vormindatud päring |
202, 204 |
Vastuvõetud ja järjestatud (202) või kustutatud ilma vastuseta (204) |
402 |
Vajalik makse: failis ei ole makseviisi, maksmata arveid ega kaardi eelluba |
403 |
Keelatud: märgis puudub, on vigane või aegunud või puudub nõutav luba. Autentimine nurjus ka 403, mitte 401. |
404 |
Ei leitud – ressurssi pole olemas |
409 |
Konflikt: näiteks juba praegu käimas olev suuruse muutmine, ebapiisav võimsus või juba käimasolev kasutuselevõtt |
429 |
Liiga palju päringuid – kiirusepiirang ületatud |
500 |
Sisemine serveri viga – midagi läks meie poolel valesti |
503 |
Teenus Ei ole saadaval: ajutine probleem. Proovi uuesti, austus pärast saatmist. |
Veakehad on JSON. Enamikul neist on detailne väli või veaväli, mõnikord sõnumiga; valideerimisvead toovad välja nime järgi esile probleemid.
Sirvi meie API dokumentatsiooni kategooriate kaupa:
Loo, kontrollida, võimu, suuruse muutmise ja kustutada servereid, lähtestada juur parool, seada vastupidine DNS, käivitada käske, ja hallata SSH võtmed.
Vaata dokumentatsiooniLoetle oma serveri varukoopiad, käivita uus varukoopia ja taasta server varukoopiast.
Vaata dokumentatsiooniVõta serverist märgistatud pildid, loetle need ja kustuta need.
Vaata dokumentatsiooniHankige saadaolevaid VPS-pakette ja hinnainfot. Hankige teavet ressursside, hinnakujunduse ja saadavuse kohta.
Vaata dokumentatsiooniLoetlege operatsioonisüsteemid ja versioonid, mida saate paigaldada, nagu Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora ja Alpine.
Vaata dokumentatsiooniKontrollige kättesaadavust, registreerida ja uuendada domeenid, ja määrata nimeserverid ja automaatne uuendamine.
Vaata dokumentatsiooniLoo DNS tsoonid ja luua, uuendada ja kustutada oma A, AAA, CNAME, MX, TXT, SRV, CAA ja muud andmed.
Vaata dokumentatsiooniLoetlege serveri käivitamiseks saadaolevad kohad.
Vaata dokumentatsiooniHangi konto profiil ja API märgi info. Määrake, milline konto märgi kuulub ja kontrollige selle õigusi.
Vaata dokumentatsiooniTõmba oma sidusettevõtte saldo, esildised, vahendustasud ja väljamaksed oma aruandlusse, muuta väljamakse seaded ja nõuda väljamakseid.
Vaata dokumentatsiooniRakenduse rakendusliidesel on ka rakenduste kasutuselevõtu tulemusnäitajad (api/v1/deploy-configs/ ja/api/v1/deployments/). Neid ei ole veel nendel lehekülgedel kirjeldatud; interaktiivses viites on loetletud kõik otseülekandes loodud tulemusnäitajad.
Interaktiivne API viide avatakseKui teil on küsimusi või vajate API-ga abi, võtke julgelt ühendust: