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

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

GebiedGroepInhoud
Bare MetalServersServers opvragen, aanmaken met uurfacturering, hernoemen, vergrendelen en verwijderen; status, abonnement en virtuele netwerken per server
VoedingVoedingsopdrachten, BMC-reset, voedings-, temperatuur- en stroommetingen
BewerkingenOS-images en applicaties, implementaties, hardwaretests en het annuleren daarvan
Externe toegangConsolesessies en virtuele media
Opstarten en iPXEAangepast iPXE-script en opstartmodus
Dienst-ISO'sISO's die een server kan koppelen en welke daarvan gekoppeld zijn
NetwerkenPoorten, segmenten en resultaten van beveiligingsscans
BandbreedteDagelijkse overdracht ten opzichte van de maandbundel en geschiedenis van verkeerssnelheden
ActiviteitAuditlog van één server
NetwerkenVirtuele netwerkenNetwerken maken, VLAN-tags, servers aansluiten en loskoppelen
IP-blokkenBlokken en adressen opvragen, een blok toevoegen of teruggeven
IP-adressenAdressen toewijzen, reserveren en vrijgeven; reverse DNS voor IPv4
BeveiligingsscansBevindingen, doelen en nieuwe scans
FactureringBestellingenBestellingen plaatsen en lezen
AbonnementenVerlengingsstatus en opzegging
FacturenFacturen lezen, betalen en downloaden
GebruikKosten in de huidige periode
Tegoed en BetaalmethodenAccounttegoed en opgeslagen kaarten
CatalogusConfiguratiesDedicated-server- en IP-blokconfiguraties met prijzen en voorraad
Regio'sDatacenters waar diensten kunnen worden besteld, met hun codes
OrganisatieBeschikbare rechtenLimieten en functies die voor de organisatie zijn ingeschakeld, waaronder uurfacturering
SSH-sleutelsOpenbare sleutels voor installatie op nieuwe servers
ActiviteitAuditlog van de organisatie
BestandenISO-bibliotheekISO's voor virtuele media uploaden en verwijderen