Aan de slag met de API
API en automatisering
Automatiseer serverimplementaties, netwerken en facturering met de Serverside.com-API. Begin met een workflow of bekijk de endpointreferentie.
Gebruik deze pagina's om Serverside.com te beheren vanuit scripts en integraties. Open de Documentatie voor instructies voor de cloudconsole.
Aan de slag met de API
Automatiseringsworkflows
- Een server implementeren: SSH-sleutels, cloud-init en implementatievoortgang.
- Voeding en externe toegang: voedingsopdrachten, consolesessies en virtuele media.
- Aangepaste iPXE-scripts: configureer een eigen opstartworkflow.
- IP-adressen beheren: adrestoewijzingen en reverse DNS.
- Virtuele netwerken instellen: netwerken maken en servers aansluiten.
Endpointreferentie
https://api.serverside.com
Aanvragen bevatten een organisatie-API-sleutel als Bearer-token in de Authorization-header (Authenticatie). Een geslaagde aanroep antwoordt met success, data en bij een gepagineerde lijst pagination; een mislukte met een HTTP-status en de foutomhulling, waarvan code aangeeft wat er misging (API-conventies).
De referentie vermeldt uitsluitend bewerkingen die een sleutel kan aanroepen. Leden, rollen, uitnodigingen, API-sleutels, meldingen, uw profiel en supporttickets worden in de cloudconsole beheerd; hun endpoints antwoorden een sleutel met 401 (Bewerkingen die een sleutel niet kan aanroepen).
Elke endpointpagina vermeldt parameters en velden, noemt waar van toepassing de gecontroleerde machtiging en toont een voorbeeldbody voor elke mogelijke antwoordstatus, inclusief fouten. De aanvraag is uitgewerkt in cURL, Node.js, Python, Go, PHP, Ruby, Java, C# en PowerShell. Try it verstuurt deze naar de live-API met de sleutel die u plakt.
De referentie wordt gegenereerd uit het OpenAPI-document voor klanten: de beschrijving van bewerkingen die een organisatie-API-sleutel kan aanroepen. Download het als JSON om een client te genereren of het in een API-tool te importeren.
Endpointgroepen
| Gebied | Groep | Inhoud |
|---|---|---|
| Bare Metal | Servers | Servers opvragen, aanmaken met uurfacturering, hernoemen, vergrendelen en verwijderen; status, abonnement en virtuele netwerken per server |
| Voeding | Voedingsopdrachten, BMC-reset, voedings-, temperatuur- en stroommetingen | |
| Bewerkingen | OS-images en applicaties, implementaties, hardwaretests en het annuleren daarvan | |
| Externe toegang | Consolesessies en virtuele media | |
| Opstarten en iPXE | Aangepast iPXE-script en opstartmodus | |
| Dienst-ISO's | ISO's die een server kan koppelen en welke daarvan gekoppeld zijn | |
| Netwerken | Poorten, segmenten en resultaten van beveiligingsscans | |
| Bandbreedte | Dagelijkse overdracht ten opzichte van de maandbundel en geschiedenis van verkeerssnelheden | |
| Activiteit | Auditlog van één server | |
| Netwerken | Virtuele netwerken | Netwerken maken, VLAN-tags, servers aansluiten en loskoppelen |
| IP-blokken | Blokken en adressen opvragen, een blok toevoegen of teruggeven | |
| IP-adressen | Adressen toewijzen, reserveren en vrijgeven; reverse DNS voor IPv4 | |
| Beveiligingsscans | Bevindingen, doelen en nieuwe scans | |
| Facturering | Bestellingen | Bestellingen plaatsen en lezen |
| Abonnementen | Verlengingsstatus en opzegging | |
| Facturen | Facturen lezen, betalen en downloaden | |
| Gebruik | Kosten in de huidige periode | |
| Tegoed en Betaalmethoden | Accounttegoed en opgeslagen kaarten | |
| Catalogus | Configuraties | Dedicated-server- en IP-blokconfiguraties met prijzen en voorraad |
| Regio's | Datacenters waar diensten kunnen worden besteld, met hun codes | |
| Organisatie | Beschikbare rechten | Limieten en functies die voor de organisatie zijn ingeschakeld, waaronder uurfacturering |
| SSH-sleutels | Openbare sleutels voor installatie op nieuwe servers | |
| Activiteit | Auditlog van de organisatie | |
| Bestanden | ISO-bibliotheek | ISO's voor virtuele media uploaden en verwijderen |