Egy token, az ügyfélpanelből létrehozva
Bearer tokenként kerül elküldésre. Igény esetén korlátozhatja csak olvasásra vagy egyetlen szolgáltatásra; a tokenek függetlenek a jelszavától, és egy token visszavonása soha nem jelentkezteti ki.
Egy token, és minden, amit az ügyfélpanel tud
JSON HTTPS-en keresztül. Nincs szükség SDK-ra, nincs külön fejlesztői fiók, és nincs olyan végpont, amely csak a panelben létezik, itt nem.
Szerver létrehozása
curl -X POST https://api.vpsoffshore.com/v1/servers \
-H "Authorization: Bearer $TOKEN" \
-d '{"plan":"reef","image":"debian-13"}'Azonnal visszaad egy build-azonosítót. A gép körülbelül hatvan másodperccel később válaszol SSH-n, és a cím már routolva van, mielőtt a hozzáférési adatok megérkeznének.
20 végpont
Minden, öt csoportban
Alap URL https://api.vpsoffshore.com/v1. Verziózva az útvonalban; a v1 továbbra is működik, amikor létrejön a v2, és a leállítás dátumát egy évvel előre bejelentjük.
Szerverek
GET
/servers
A fiókon lévő minden szolgáltatás, állapottal, csomaggal és címekkel.
POST
/servers
Hozzon létre egyet. Azonnal egy build-azonosítót ad vissza; a szerver kb. egy perc múlva érhető el.
GET
/servers/{id}
Egy szolgáltatás, az elmúlt óra élő erőforrás-használatával együtt.
PATCH
/servers/{id}
Csomagváltás. Újraépítés nélküli átméretezés, ahol a lemez ezt lehetővé teszi.
DELETE
/servers/{id}
Semmisítse meg. A lemezeket 14 napig őrizzük meg, majd újrakiadás előtt töröljük.
POST
/servers/{id}/actions
reboot · shutdown · start · rebuild · rescue · reset-password.
Tárhely
GET
/servers/{id}/snapshots
Pillanatképek egy szolgáltatáshoz, a legújabbal kezdve.
POST
/servers/{id}/snapshots
Készítsen egyet. Vékony, így gyors, és nem duplázza meg a lemezhasználatot.
POST
/snapshots/{id}/restore
Helyreállítás a helyén, vagy egy másik, azonos vagy nagyobb csomagú szolgáltatásra.
DELETE
/snapshots/{id}
Pillanatkép törlése.
Hálózat
GET
/servers/{id}/addresses
Egy szolgáltatáshoz routolt címek, v4 és v6.
POST
/servers/{id}/addresses
Igényeljen egy további címet, vagy egy /29-es tartományt.
PUT
/addresses/{ip}/rdns
Állítsa be a fordított DNS-t. Egy percen belül életbe lép, nem a következő zónafrissítéskor.
GET
/servers/{id}/bandwidth
Forgalomszámlálók. Tájékoztató jellegűek — nincs túlléphető keret.
Katalógus
GET
/plans
Minden csomag a specifikációjával és árával. Ugyanaz a forrás, amelyből ez az oldal is épül.
GET
/images
Elérhető image-ek és ISO-k, beleértve az Ön által feltöltötteket is.
POST
/images
Töltsön fel egy ISO-t URL alapján. Konzollal csatlakoztatva indul.
Számlázás
GET
/invoices
Számlák, kifizetett és nyitott egyaránt, az érmével és a láncbeli tranzakcióval együtt.
POST
/invoices/{id}/pay
Fizetési cím kiállítása a 8 elfogadott érme egyikéhez.
GET
/credits
Alkalmazott SLA-jóváírások, az egyes eseteket kiváltó incidenssel együtt.
Amit az ügyfélpanel tud, az itt is elérhető, és semmi nincs itt, ami hiányozna az ügyfélpanelből. Ha a kettő eltér, az hiba — jelezze nekünk az ügyfélpanelből, és javítjuk, ahelyett hogy szándékolt viselkedésként dokumentálnánk.
Hogyan viselkedik
Négy döntés, amelyet egy órán belül észrevesz
Egy API-t a rossz útjai alapján ítélünk meg, nem a jók alapján. Az alábbi négyből három azzal foglalkozik, mi történik, ha valami elromlik.
JSON be, JSON ki, SDK nélkül
Egyszerű HTTPS, egyedi burkolat, XML-alapú tartalék és aláírási szertartás nélkül. Ha a curl meg tudja csinálni, akkor Önnek van kliense. Hivatalos könyvtárak léteznek Go, Python és TypeScript nyelvekhez, de egyik sem kötelező.
Sebességkorlátok, amelyekbe véletlenül nem fog beleütközni
Tokenenként percenként 600 kérés, létrehozási hívásoknál 60. Minden válasz fejléce megadja a fennmaradó keretet, túllépés esetén 429-es hibakód érkezik a várakozási idővel másodpercben — sosem néma eldobás.
Hibaüzenetek, amelyek megmondják, mit kell tenni
A 4xx-es válasz gépileg olvasható kódot, egy emberi mondatot és a hibás mezőt tartalmazza. Inkább adunk hosszú hibaüzenetet, mint egy rövidet, amelyet Önnek ki kellene találnia.
A két dolog, amelyet csak egyszer kell megadnia
Hitelesítés, és hogyan néz ki egy hiba
Mindkettőt érdemes elolvasni, mielőtt megírja az első hívást, nem pedig az első hiba után.
Hitelesítés
curl https://api.vpsoffshore.com/v1/servers \
-H "Authorization: Bearer $TOKEN"A tokeneket az ügyfélpanelben hozza létre, és korlátozhatók csak olvasásra vagy egyetlen szolgáltatásra. Függetlenek a jelszavától, és egy visszavonása sehol nem jelentkezteti ki.
Olvassa el a sebességkorlátot
X-RateLimit-Remaining: 574
X-RateLimit-Reset: 41Minden válaszban, nem csak a sikertelenben. A limit túllépése 429-es választ ad, a várakozási másodpercekkel, soha nem néma eldobással és soha nem rövidített válasszal.
A hiba megmutatja a mezőt
{"error":"plan_unknown",
"message":"No plan named 'reff'. Did you mean 'reef'?",
"field":"plan"}Egy géppel olvasható kód, egy emberi mondat és a hibás mező. A hosszú hibaüzenetek olcsóbbak, mint a rövidek, amelyeket ki kell találni.
Konfiguráció lekérdezése
curl https://api.vpsoffshore.com/v1/servers/$ID \
-H "Authorization: Bearer $TOKEN" | jq .statebuilding állapotból running állapotba kerül. Nincs olyan webhook, amelyet regisztrálnia kellene, mielőtt bármit létrehozhatna, és a másodpercenkénti lekérdezés a határon belül van.
Nincs mit kérvényezni
A token a panelben található, és a panel az első szerverrel együtt jár
Nincs fejlesztői fiók, nincs jóváhagyás, nincs olyan sandbox, amely másképp viselkedik, mint az éles rendszer.