Yksi token, luotu paneelissa
Lähetetään bearer-tokenina. Voit halutessasi rajata sen vain luku -oikeuteen tai yhteen palveluun; tokenit ovat riippumattomia salasanastasi, eikä minkään tokenin kumoaminen koskaan kirjaa sinua ulos.
Yksi token, ja kaikki, mitä paneeli osaa tehdä
JSON, HTTPS-yhteyden kautta. Ei vaadittua SDK-kirjastoa, ei erillistä kehittäjätiliä eikä päätepistettä, joka olisi olemassa paneelissa mutta ei täällä.
Luo palvelin
curl -X POST https://api.vpsoffshore.com/v1/servers \
-H "Authorization: Bearer $TOKEN" \
-d '{"plan":"reef","image":"debian-13"}'Palauttaa kokoonpanotunnuksen välittömästi. Kone vastaa SSH-yhteyteen noin kuudenkymmenen sekunnin kuluttua, ja osoite on reititetty ennen kuin tunnukset lähetetään.
20 päätepistettä
Kaikki, viidessä ryhmässä
Perus-URL https://api.vpsoffshore.com/v1. Versioitu polussa; v1 toimii edelleen, kun v2 on olemassa, ja päivä, jolloin se lakkaa toimimasta, ilmoitetaan vuotta etukäteen.
Palvelimet
GET
/servers
Jokainen tilin palvelu, tilan, paketin ja osoitteiden kanssa.
POST
/servers
Luo yksi. Palauttaa heti build id -tunnuksen; palvelin on tavoitettavissa noin minuutin kuluttua.
GET
/servers/{id}
Yksi palvelu, mukaan lukien resurssien käyttö reaaliajassa viimeisen tunnin ajalta.
PATCH
/servers/{id}
Vaihda paketti. Kokoa muutetaan ilman uudelleenrakennusta, jos levy sen sallii.
DELETE
/servers/{id}
Tuhoa se. Levyt säilytetään 14 päivää ja pyyhitään ennen uudelleenkäyttöä.
POST
/servers/{id}/actions
reboot · shutdown · start · rebuild · rescue · reset-password.
Tallennustila
GET
/servers/{id}/snapshots
Tilannekuvat yhdelle palvelulle, uusimmat ensin.
POST
/servers/{id}/snapshots
Otetaan yksi. Ohut, joten se on nopea eikä kaksinkertaista levytilan käyttöä.
POST
/snapshots/{id}/restore
Palautus samalle palvelimelle, tai toiselle samaa tai suurempaa pakettia olevalle palvelulle.
DELETE
/snapshots/{id}
Poista tilannevedos.
Verkko
GET
/servers/{id}/addresses
Palvelulle reititetyt osoitteet, v4 ja v6.
POST
/servers/{id}/addresses
Pyydä lisäosoite tai /29-lohko.
PUT
/addresses/{ip}/rdns
Aseta reverse DNS. Astuu voimaan minuutin sisällä, ei seuraavassa vyöhykkeen päivityksessä.
GET
/servers/{id}/bandwidth
Siirtolaskurit. Vain tiedoksi — ylitettävää kiintiötä ei ole.
Tuoteluettelo
GET
/plans
Jokainen paketti hintoineen ja teknisine tietoineen — samasta lähteestä, josta tämä sivusto renderöityy.
GET
/images
Käytettävissä olevat levykuvat ja ISO-tiedostot, mukaan lukien itse ladatut.
POST
/images
Lataa ISO URL-osoitteesta. Käynnistyy konsoli liitettynä.
Laskutus
GET
/invoices
Laskut, maksetut ja avoimet, kolikkoineen ja lohkoketjutapahtumineen.
POST
/invoices/{id}/pay
Luo maksuosoite yhdelle 8 hyväksytystä kolikosta.
GET
/credits
Sovelletut SLA-hyvitykset, sekä tapahtuma, joka tuotti kunkin niistä.
Kaikki, mitä paneeli osaa tehdä, on täällä, eikä täältä puutu mitään paneelista. Kun nämä kaksi ovat ristiriidassa, kyse on virheestä — kerro meille paneelista, ja se korjataan sen sijaan, että se dokumentoitaisiin tarkoitetuksi toiminnaksi.
Miten se toimii
Neljä päätöstä, jotka huomaa tunnin sisällä
API arvioidaan sen huonojen polkujen perusteella, ei hyvien. Kolme alla olevista neljästä käsittelee sitä, mitä tapahtuu, kun jokin menee pieleen.
JSON sisään, JSON ulos, ei SDK-riippuvuutta
Pelkkä HTTPS ilman omaa kirjekuorta, ilman XML-varajärjestelmää ja ilman allekirjoitusrituaalia. Jos curl osaa sen, asiakasohjelma on jo olemassa. Virallisia kirjastoja on saatavilla Go-kielelle, Pythonille ja TypeScriptille, eikä mikään niistä ole pakollinen.
Nopeusrajoitukset, joihin et törmää vahingossa
600 pyyntöä minuutissa tokenia kohden, luontikutsuille 60. Jokainen vastaus sisältää jäljellä olevan käyttöoikeuden otsakkeessa, ja rajan ylittyessä palautuu 429 sekä sekuntimäärä, joka on odotettava — ei koskaan hiljaista pudotusta.
Virheilmoitukset, jotka kertovat, mitä tehdä
4xx-vastaus sisältää koneluettavan koodin, selkeän lauseen ja virheellisen kentän. Palautamme mieluummin pitkän virheilmoituksen kuin lyhyen, jota joutuu arvailemaan.
Kaksi asiaa, jotka kirjoitetaan vain kerran
Todennus ja miltä virhe näyttää
Molemmat kannattaa lukea ennen ensimmäistä kutsua, ei vasta ensimmäisen epäonnistumisen jälkeen.
Todenna
curl https://api.vpsoffshore.com/v1/servers \
-H "Authorization: Bearer $TOKEN"API-tunnukset luodaan asiakaspaneelissa, ja ne voidaan rajata vain luku -oikeuteen tai yhteen palveluun. Ne ovat riippumattomia salasanasta, eikä minkään tunnuksen mitätöiminen kirjaa ulos mistään.
Lue pyyntörajoitus
X-RateLimit-Remaining: 574
X-RateLimit-Reset: 41Joka vastauksessa, ei vain siinä, joka epäonnistuu. Rajan ylittyessä palautetaan 429 ja odotettavat sekunnit, ei koskaan hiljaista pudotusta eikä koskaan lyhennettyä vastausta.
Virheilmoitus kertoo kentän
{"error":"plan_unknown",
"message":"No plan named 'reff'. Did you mean 'reef'?",
"field":"plan"}Koneluettava koodi, ihmisluettava lause ja virheellinen kenttä. Pitkät virheilmoitukset ovat halvempia kuin lyhyet, joita joutuu arvailemaan.
Kokoonpanon tilan kysely
curl https://api.vpsoffshore.com/v1/servers/$ID \
-H "Authorization: Bearer $TOKEN" | jq .stateEtenee tilasta building tilaan running. Mitään webhookia ei tarvitse rekisteröidä ennen kuin mitään voi luoda, ja kerran sekunnissa tapahtuva pollaus pysyy rajan sisällä.
Ei mitään haettavaa
Token löytyy paneelista, ja paneeli tulee ensimmäisen palvelimen mukana
Ei kehittäjätiliä, ei hyväksyntää, ei hiekkalaatikkoa, joka toimisi eri tavalla kuin tuotanto.