De Wolkra API is een REST API op https://api.wolkra.com/v1 waarmee je vanuit je eigen code servers, volumes, netwerken, firewalls en load balancers aanmaakt en beheert. Verzoeken worden geauthenticeerd met tokens per project, die je kunt beperken tot alleen-lezen, tot bepaalde IP-adressen en tot een vaste looptijd.
Wat de API dekt
De API volgt wat je in de console doet. Veelvoorkomende taken:
- Cloudservers aanmaken, vergroten, opnieuw opbouwen, aan- of uitzetten en verwijderen
- Blokopslagvolumes aanmaken, koppelen, vergroten en ontkoppelen
- Back-ups inschakelen en snapshots maken
- Privénetwerken en NAT-gateways opzetten
- Firewalls, load balancers, floating IP's en reverse DNS beheren
Alles werkt met JSON over HTTPS, met standaard HTTP-methodes en statuscodes.
API-tokens
Tokens maak je in de console aan, onder de instellingen van je project.
| Optie | Wat het doet |
|---|---|
| Projectscope | Een token werkt alleen voor één project |
Prefix wk_ |
Maakt Wolkra-tokens makkelijk herkenbaar in code en voor secret scanners |
| Alleen-lezen of lezen/schrijven | Alleen-lezentokens kunnen opvragen en inspecteren, lees/schrijftokens kunnen ook wijzigen |
| IP-allowlist | Optioneel, weigert verzoeken vanaf elk ander adres |
| Vervaldatum | Optioneel, het token werkt niet meer na een datum die jij kiest |
Geef elk script of elke dienst een eigen token met de kleinste scope die volstaat. Een monitoringscript heeft genoeg aan alleen-lezen. Een deploymentpipeline heeft lezen/schrijven nodig, een allowlist voor zijn runners en een vervaldatum die je steeds verlengt.
Een eerste verzoek
Stuur het token mee als bearer-token:
curl -H "Authorization: Bearer wk_your_token_here" \
https://api.wolkra.com/v1/servers
Het antwoord toont de servers in het project van het token. De documentatie over API-tokens laat stap voor stap zien hoe je een token aanmaakt en je eerste calls doet.
Hoe teams de API gebruiken
- Deploymentpipelines maken een server aan, wachten tot hij is opgestart, voeren een deploy uit en werken een load balancer bij.
- Failoverscripts verplaatsen een floating IP zodra de actieve server niet meer reageert.
- Veilige releases maken vóór elke release een snapshot en ruimen oude snapshots later op.
- Kortlevende omgevingen starten servers voor een branch of testrun en verwijderen ze als ze klaar zijn. Met facturering per uur kost een server die twee uur draait ook twee uur. Zie ontwikkelomgevingen.
- Elastische CI-runners voegen servers toe als wachtrijen groeien en halen ze weg als die leeg zijn.
- Interne dashboards lezen servers en grafieken uit met een alleen-lezentoken.
Console, Composer en API samen
De console, Composer en de API werken allemaal op dezelfde resources. Je kunt een stack tekenen in Composer, die toepassen en hem daarna vanuit scripts beheren. Wijzigingen via elk van de drie verschijnen in het activiteitenlogboek van het project, zodat teams zien wie wat heeft gedaan. Zie teams en beveiliging.
Werkt met elke taal
Omdat de API gewoon REST met JSON is, heb je geen speciale library nodig. Een shellscript met curl en jq, een Python-script met een HTTP-client, een Go-service of een Node.js-job werken allemaal op dezelfde manier: stuur een verzoek met het bearer-token, lees het JSON-antwoord, controleer de statuscode. Antwoorden beschrijven elke resource met ID, naam, labels en status. Zo kan een script een server aanmaken, pollen tot hij draait en dan een volume koppelen of hem aan een load balancer toevoegen.
Goede gewoontes voor scripts:
- Zoek resources op via labels in plaats van ID's hard te coderen.
- Controleer de HTTP-statuscode van elke call en stop bij fouten.
- Poll op statuswijzigingen met een pauze tussen verzoeken, niet in een strakke lus.
- Gebruik aparte tokens voor aparte taken, zodat het intrekken van één token de rest niet breekt.
Beveiligingstips
- Behandel tokens als wachtwoorden. Bewaar ze in een secret manager of de secret store van je CI, nooit in een openbare repository.
- Gebruik de IP-allowlist voor tokens die vanaf vaste adressen draaien.
- Stel een vervaldatum in voor tokens van freelancers en tijdelijke taken.
- Trek een token direct in via de console zodra je vermoedt dat het is uitgelekt.
Goed om te weten
- De API is dé manier om Wolkra te automatiseren. Gebruik curl of een andere HTTP-client.
- Elk token werkt binnen één project.
- Resources worden aangemaakt in Frankfurt, op dit moment onze enige locatie.
Gerelateerde pagina's
Begin met automatiseren
Maak een project aan, genereer een token en doe binnen enkele minuten je eerste call. Maak een Wolkra-account aan.
Veelgestelde vragen
Waar vind ik de Wolkra API?
De REST API staat op https://api.wolkra.com/v1. Hij werkt met JSON over HTTPS en je authenticeert met een API-token in de Authorization-header.
Hoe werken API-tokens?
Je maakt tokens aan in de console. Elk token hoort bij één project, begint met wk_ en is alleen-lezen of lezen/schrijven. Je kunt een IP-allowlist en een vervaldatum toevoegen.
Welke tools kan ik met de API gebruiken?
Elke tool die HTTPS en JSON spreekt, werkt: van curl in een shellscript tot de HTTP-client van je favoriete programmeertaal.
Wat kan ik met de API doen?
De API dekt de resources die je in de console beheert, zoals servers, volumes, netwerken, firewalls, load balancers en IP-adressen.
Is de API gratis te gebruiken?
Ja. API-calls kosten niets. Je betaalt alleen voor de resources die je aanmaakt, per uur gefactureerd vanuit je prepaid tegoed.