De Worldstream API gebruiken
Kort antwoord
De Worldstream API is bedoeld voor scripts, CI en AI-agents, niet om mee rond te klikken in een browser. Maak een API key aan in Portal onder Developers → API en authenticeer daarna elke request met een X-API-Key header, niet met een bearer token, tegen https://api.worldstream.com. De API heeft een rate limit van 200 requests per minuut per IP-adres.
Worldstream ondersteunt ook het koppelen van AI-assistenten en -agents aan deze API via MCP (Model Context Protocol). Zie Worldstream gebruiken via MCP voor de installatie en wat er op dit moment end-to-end mogelijk is.
Wat je nodig hebt voordat je begint
- Een Worldstream-account met toegang tot Portal
- Een API key, aangemaakt via API onder Developers
- Een tool om HTTPS-requests te doen:
curl, Postman, of de HTTP-client van je programmeertaal
Een API key aanmaken
Open API onder Developers
Ga in Portal naar Developers → API en open het tabblad Keys.
Klik op Create Key
Vul een Key Name in, kies onder Expires In hoe lang de key geldig moet blijven, en stel de permissies in die de key nodig heeft.
Kopieer de secret meteen
Ga ervan uit dat je de secret niet meer terugziet zodra je het scherm verlaat. Sla hem meteen ergens veilig op, bijvoorbeeld in een password manager of secrets store. Plak een API secret nooit in een support ticket.
Datzelfde Keys-gebied heeft ook een API IP allowlist, die beperkt welke adressen met een key mogen authenticeren. Die kent drie modi: Off, Report only en Enforce. Dit geldt alleen voor authenticatie met een API key, het heeft geen effect op inloggen met een browser in Portal.
Authenticeren
Stuur de key als X-API-Key header mee met elke request. Het is geen bearer token, dus zet hem niet in een Authorization: Bearer header.
curl -H "X-API-Key: <your-api-key>" \
https://api.worldstream.com/<family>/v1/<command>Endpoints zijn gegroepeerd per productfamilie en volgen het patroon api.worldstream.com/<family>/v1/<command>. Haal het exacte pad voor elke call uit het tabblad Endpoints in Portal, dat live wordt gegenereerd uit dezelfde OpenAPI spec als Download Spec.
Rate limits
De API staat 200 requests per minuut per IP-adres toe. Ga je daaroverheen, dan krijg je een HTTP 429-respons met een Retry-After header die aangeeft hoe lang je moet wachten voor je volgende request. Bouw je retry-logica rond die header in plaats van een interval te gokken, zeker bij scripts die op een vast schema pollen.
Endpoints en documentatie vinden
De API-sectie in Portal toont alleen wat past bij jouw eigen toegang:
- My APIs toont wat jouw account en key daadwerkelijk kunnen aanroepen.
- Full reference toont elk beschikbaar endpoint, ongeacht je huidige toegang.
- Download Spec levert je de OpenAPI spec, om clients te genereren of tooling op te zetten.
- Met View JSON en API Explorer inspecteer en test je endpoints direct in de portal.
- Infrastructure as Code geeft je kant-en-klare Ansible- en Terraform-templates, gebouwd vanuit de live spec.
- Examples bevat een MCP Server Setup-gids voor het koppelen van de API aan Cursor of Claude Desktop, zie Worldstream gebruiken via MCP.
Roep je een endpoint aan waar je account of key geen toegang toe heeft, dan krijg je een HTTP 403.
Krijg je een 403, controleer dan Recent API key denials op het tabblad Keys. Dat laat zien of de weigering kwam door een permissieprobleem of door een IP-restrictie vanuit de API IP allowlist.
Veelgebruikte taken
Elk endpoint volgt hetzelfde patroon: https://api.worldstream.com/<family>/v1/<command>. De tabel hieronder laat zien hoe dat patroon zich vertaalt naar typische taken. Haal het exacte pad voor elke call uit het tabblad Endpoints, View JSON of API Explorer in Portal, in plaats van deze paden letterlijk over te nemen.
| Taak | Illustratief endpoint-patroon |
|---|---|
| Je Flexible VPS-instances weergeven | GET /flexible-vps/v1/vms |
| Een Flexible VPS aanmaken | POST /flexible-vps/v1/vms |
| Een VPS aan-/uitzetten of herstarten | POST /flexible-vps/v1/vms/{id}/actions |
| Dedicated servers weergeven | GET /dedicated/v1/dedicated-servers |
| Het OS van een dedicated server opnieuw installeren | POST /dedicated/v1/dedicated-servers/{id}/reinstall |
| Reverse DNS instellen op een IP | PUT /ip-management/v1/dns/reverse-records/{id} |
| Een Object Storage bucket aanmaken | POST /storage/v1/object-storage/buckets |
| Een support ticket openen | POST /support/v1/tickets |
| De kosten van een configuratie inschatten | POST /account/v1/pricing/estimate |
De API-families en hun omvang zijn: Account (27 endpoints), Flexible VPS (88), Kubernetes (27), Dedicated Servers (25), Storage (14), Datacenter (20), IP Management (8), Monitoring (9) en Support (6), in totaal 224 endpoints. Elke familie dekt de taken die je op basis van de naam zou verwachten. Flexible VPS dekt bijvoorbeeld de volledige VM-levenscyclus (aanmaken, aan-/uitzetten, resizen, redeployen, snapshots, backups, netwerken, firewalls, VPN, ISO's, images), en Dedicated Servers dekt aan-/uitzetten, herinstalleren, opzeggen, traffic en uplinks. Zie het tabblad Endpoints in Portal voor de volledige, actuele lijst, gegroepeerd per familie. Let op wat er niet bij zit: er is op dit moment geen endpoint voor accountregistratie of het toevoegen van een betaalmethode, facturatie en billingbeheer gebeuren nog steeds in Portal zelf.