Teljes REST API dokumentáció a VPS szerverek, domainek, DNS, biztonsági mentések és egyebek kezeléséhez.
A VPS.org API lehetővé teszi a VPS-tárhelyinfrastruktúra minden aspektusának programozott kezelését, beleértve a szervereket, domaineket, DNS-rekordokat, biztonsági mentéseket és pillanatképeket.
Minden API-kérelem hitelesítést igényel egy Bearer token használatával. Az API-tokent a fiókbeállításaiban hozhatja létre a következő címen: 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);Minden token saját jogosultságokat hordoz, mint például szerverek:listát vagy dns:*. A kérés, hogy engedély kell a token nem rendelkezik, 403 és a szükséges_permission mező neve a hiányzó engedély. Az engedély hivatkozási száma
A hitelesített kérések óránként 1000-re korlátozódnak számlaszámonként. A nem hitelesített kérések óránként 100-ra korlátozódnak IP-címenként. A limiten felüli kérés 429-et kap egy Retry-After fejlécen, ami másodpercek számát adja meg a várakozáshoz. A sikeres válaszokra nem küldünk díjkorlátot.
A végpontok listája visszaküld egy objektumot számokkal, következő, előző és eredmény, 25 elem oldalonként. Pass oldalt mozgatni oldalak között, vagy kövesse a következő URL-t, amíg nincs. A szerverlista elfogadja a page_size-t is, akár 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}Az API szabványos HTTP állapotkódokat használ a siker vagy a sikertelenség jelzésére:
| Állapotkód | Leírás |
|---|---|
200 |
Siker - A kérés sikeresen teljesítve |
201 |
Létrehozva – Erőforrás sikeresen létrehozva |
400 |
Hibás kérés - Érvénytelen paraméterek vagy helytelenül formázott kérés |
202, 204 |
Elfogadott és sorban álló (202) vagy válaszszerv nélkül törölt (204) |
402 |
Fizetés Szükséges: nincs fizetési mód fájlban, kifizetetlen számlákon vagy a kártya elutasításának elő-engedélyezése |
403 |
Tiltott: a token hiányzik, érvénytelen vagy lejárt, vagy hiányzik a szükséges engedély. A nem sikerült hitelesítés is 403, nem 401. |
404 |
Nem található - Az erőforrás nem létezik |
409 |
Konfliktus: például egy már folyamatban lévő átméretezés, nem elegendő kapacitás vagy már folyamatban lévő telepítés |
429 |
Túl sok kérés - Túllépte a sebességkorlátot |
500 |
Belső szerverhiba - Valami hiba történt a mi oldalunkon |
503 |
Szolgáltatás Nem elérhető: ideiglenes probléma. Vissza, tiszteletben tartása Retry-After when it is send. |
Hibaszervek JSON. A legtöbbjüknek van egy részletes mezője vagy egy hibamezője, néha üzenettel; érvényesítési hibák listázza a problémákat a mező neve alapján.
Böngésszen API dokumentációnkban kategóriák szerint:
A szerverek létrehozása, ellenőrzése, hatalom, átméretezése és törlése, a root jelszó visszaállítása, a DNS-fordítás beállítása, parancsok futtatása és az SSH billentyűk kezelése.
Dokumentáció megtekintéseA kiszolgáló biztonsági mentései listája, új mentés indítása, és a kiszolgáló visszaállítása egy mentésből.
Dokumentáció megtekintéseA felcímkézett fényképeket a kiszolgálóról, listázza és törli azokat.
Dokumentáció megtekintéseElérhető VPS-csomagok és árképzési információk lekérése. Részletek az erőforrásokról, az árakról és az elérhetőségről.
Dokumentáció megtekintéseListázza az operációs rendszereket és verziókat, amelyeket telepíthet, mint például Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora és Alpine.
Dokumentáció megtekintéseEllenőrizze a rendelkezésre álló, regisztrálni és megújítani domaineket, és állítsa be a névszervereket és az automatikus megújulást.
Dokumentáció megtekintéseHozzon létre DNS zónákat, és hozzon létre, frissítse és törölje az A, A, CNAME, MX, TXT, SRV, CAA és egyéb rekordok.
Dokumentáció megtekintéseA kiszolgáló telepítéséhez rendelkezésre álló helyszínek felsorolása.
Dokumentáció megtekintéseA számlaprofil és az API token információk letöltése. Azonosítsa, hogy melyik számlához tartozik a token, és ellenőrizze az engedélyeit.
Dokumentáció megtekintéseHúzza le a partneri egyenlegét, áttételeit, jutalékait és kifizetéseit saját jelentésébe, változtasson a kifizetési beállításokon és kérjen kifizetést.
Dokumentáció megtekintéseAz API-nak az alkalmazás telepítésére vonatkozó végpontjai is vannak (/api/v1/deployment-configs/ and /api/v1/deployments/). Ezek még nem szerepelnek ezeken az oldalakon; az interaktív referencialisták minden, az élő API-ból származó végpontot felsorolnak.
Az interaktív API-hivatkozás megnyitásaHa kérdése van, vagy segítségre van szüksége az API-val kapcsolatban, kérjük, ne habozzon kapcsolatba lépni velünk: