Wolkra API on REST API osoitteessa https://api.wolkra.com/v1, jolla luot ja hallitset palvelimia, levyjä, verkkoja, palomuureja ja kuormantasaajia omasta koodistasi. Pyynnöt todennetaan projektikohtaisilla tunnisteilla, jotka voit rajata vain lukuoikeuteen, tiettyihin IP-osoitteisiin ja kiinteään voimassaoloaikaan.
Mitä API kattaa
API vastaa sitä, mitä teet konsolissa. Tyypillisiä tehtäviä ovat:
- Pilvipalvelimien luonti, koon muutos, uudelleenasennus, käynnistys, sammutus ja poisto
- Lohkotallennuslevyjen luonti, liittäminen, kasvattaminen ja irrottaminen
- Varmuuskopioiden käyttöönotto ja tilannevedosten ottaminen
- Yksityisverkkojen ja NAT-yhdyskäytävien määrittäminen
- Palomuurien, kuormantasaajien, kelluvien IP-osoitteiden ja käänteisen DNS:n hallinta
Kaikki toimii JSONilla HTTPS:n yli, tavallisilla HTTP-metodeilla ja tilakoodeilla.
API-tunnisteet
Tunnisteet luodaan konsolissa projektin asetuksista.
| Asetus | Mitä se tekee |
|---|---|
| Projektirajaus | Tunniste toimii vain yhdessä projektissa |
wk_-etuliite |
Wolkran tunnisteet on helppo tunnistaa koodista ja salaisuusskannereista |
| Luku tai luku/kirjoitus | Vain luku -tunnisteilla voi listata ja tarkastella, luku/kirjoitus-tunnisteilla myös muuttaa |
| IP-sallittujen lista | Valinnainen, hylkää pyynnöt kaikista muista osoitteista |
| Vanheneminen | Valinnainen, tunniste lakkaa toimimasta valitsemanasi päivänä |
Anna jokaiselle skriptille tai palvelulle oma tunniste, jonka oikeudet ovat niin suppeat kuin mahdollista. Valvontaskripti tarvitsee vain lukuoikeuden. Käyttöönottoputki tarvitsee luku/kirjoitusoikeuden, sallittujen listan ajureilleen ja vanhenemispäivän, jonka uusit.
Ensimmäinen pyyntö
Lähetä tunniste bearer-tunnisteena:
curl -H "Authorization: Bearer wk_your_token_here" \
https://api.wolkra.com/v1/servers
Vastaus listaa tunnisteen projektin palvelimet. API-tunnisteiden ohje näyttää vaihe vaiheelta, miten tunniste luodaan ja ensimmäiset kutsut tehdään.
Miten tiimit käyttävät API:a
- Käyttöönottoputket luovat palvelimen, odottavat sen käynnistymistä, ajavat julkaisun ja päivittävät kuormantasaajan.
- Vikasietoskriptit siirtävät kelluvan IP:n, kun aktiivinen palvelin lakkaa vastaamasta.
- Turvalliset julkaisut ottavat tilannevedoksen ennen jokaista julkaisua ja poistavat vanhat myöhemmin.
- Lyhytikäiset ympäristöt käynnistävät palvelimia haaralle tai testiajolle ja poistavat ne lopuksi. Tuntilaskutuksella kaksi tuntia elävä palvelin maksaa kaksi tuntia. Katso kehitysympäristöt.
- Joustavat CI-ajurit lisäävät palvelimia jonojen kasvaessa ja poistavat ne jonojen tyhjentyessä.
- Sisäiset kojelaudat lukevat palvelimia ja kuvaajia vain luku -tunnisteella.
Konsoli, Composer ja API yhdessä
Konsoli, Composer ja API käsittelevät samoja resursseja. Voit piirtää kokonaisuuden Composerissa, ottaa sen käyttöön ja hallita sitä sen jälkeen skripteillä. Kaikkien niiden tekemät muutokset näkyvät projektin tapahtumalokissa, joten tiimi näkee, kuka teki mitä. Katso tiimit ja tietoturva.
Toimii millä tahansa kielellä
Koska API on pelkkää RESTiä ja JSONia, erillistä kirjastoa ei tarvita. Shell-skripti curlilla ja jq:lla, Python-skripti HTTP-asiakkaalla, Go-palvelu tai Node.js-työ toimivat kaikki samoin: lähetä pyyntö bearer-tunnisteen kanssa, lue JSON-vastaus ja tarkista tilakoodi. Vastaukset kuvaavat jokaisen resurssin tunnuksen, nimen, tunnisteiden (labels) ja tilan, joten skripti voi luoda palvelimen, odottaa, kunnes se on käynnissä, ja liittää sitten levyn tai lisätä palvelimen kuormantasaajaan.
Hyviä käytäntöjä skripteille:
- Etsi resursseja labelien avulla, älä kovakoodaa tunnuksia.
- Tarkista jokaisen kutsun HTTP-tilakoodi ja pysähdy virheisiin.
- Kysele tilamuutoksia tauon kanssa pyyntöjen välillä, älä tiiviissä silmukassa.
- Pidä eri töille erilliset tunnisteet, jotta yhden mitätöinti ei riko muita.
Tietoturvahuomioita
- Käsittele tunnisteita kuin salasanoja. Säilytä ne salaisuuksien hallinnassa tai CI:n salaisuusvarastossa, älä koskaan julkisessa repositoriossa.
- Käytä IP-sallittujen listaa tunnisteille, joita ajetaan kiinteistä osoitteista.
- Aseta vanhenemispäivä alihankkijoiden ja tilapäisten töiden tunnisteille.
- Mitätöi tunniste konsolissa heti, kun epäilet sen vuotaneen.
Hyvä tietää
- API on tapa automatisoida Wolkraa. Käytä curlia tai mitä tahansa HTTP-asiakasta.
- Jokainen tunniste toimii yhden projektin sisällä.
- Resurssit luodaan Frankfurtiin, joka on tällä hetkellä ainoa sijaintimme.
Aiheeseen liittyvät sivut
Aloita automatisointi
Luo projekti, tee tunniste ja tee ensimmäinen kutsusi muutamassa minuutissa. Luo tili Wolkraan.
Usein kysytyt kysymykset
Missä Wolkran API on?
REST API löytyy osoitteesta https://api.wolkra.com/v1. Se käyttää JSONia HTTPS:n yli, ja pyynnöt todennetaan API-tunnisteella Authorization-otsakkeessa.
Miten API-tunnisteet toimivat?
Luot tunnisteet konsolissa. Jokainen tunniste kuuluu yhteen projektiin, alkaa merkkijonolla wk_ ja on joko vain luku- tai luku/kirjoitusoikeudellinen. Voit lisätä IP-sallittujen listan ja vanhenemispäivän.
Mitä työkaluja voin käyttää API:n kanssa?
Mikä tahansa HTTPS:ää ja JSONia ymmärtävä työkalu toimii, shell-skriptin curlista suosikkiohjelmointikielesi HTTP-asiakkaaseen.
Mitä API:lla voi tehdä?
API kattaa konsolissa hallitsemasi resurssit, kuten palvelimet, levyt, verkot, palomuurit, kuormantasaajat ja IP-osoitteet.
Onko API:n käyttö ilmaista?
Kyllä. API-kutsuista ei veloiteta. Maksat vain luomistasi resursseista, ja ne laskutetaan tunneittain ennakkosaldostasi.