Erste Schritte mit der API
API und Automatisierung
Automatisieren Sie Serverbereitstellung, Netzwerke und Abrechnung mit der Serverside.com-API. Beginnen Sie mit einem Ablauf oder der Endpunktreferenz.
Verwalten Sie Serverside.com mit diesen Seiten über Skripte und Integrationen. Anleitungen für die Cloud-Konsole finden Sie in der Dokumentation.
Mit der API beginnen
Automatisierungsabläufe
- Server bereitstellen: SSH-Schlüssel, cloud-init und Bereitstellungsfortschritt.
- Strom und Fernzugriff: Strombefehle, Konsolensitzungen und virtuelle Medien.
- Eigene iPXE-Skripte: eigenen Startablauf konfigurieren.
- IP-Adressen verwalten: Adresszuweisungen und Reverse DNS.
- Virtuelle Netzwerke einrichten: Netzwerkerstellung und Serververbindungen.
Endpunktreferenz
https://api.serverside.com
Anfragen enthalten einen Organisations-API-Schlüssel als Bearer-Token im Header Authorization (Authentifizierung). Ein erfolgreicher Aufruf antwortet mit success, data und bei paginierten Listen pagination; ein fehlgeschlagener mit HTTP-Status und Fehlerhülle, deren code den Fehler benennt (API-Konventionen).
Die Referenz führt ausschließlich die Vorgänge auf, die ein Schlüssel aufrufen kann. Mitglieder, Rollen, Einladungen, API-Schlüssel, Benachrichtigungen, Ihr Profil und Supporttickets werden in der Cloud-Konsole verwaltet; ihre Endpunkte antworten einem Schlüssel mit 401 (Nicht mit einem Schlüssel aufrufbare Vorgänge).
Jede Endpunktseite führt Parameter und Felder auf, nennt gegebenenfalls die vom Vorgang geprüfte Berechtigung und zeigt einen Beispielbody für jeden möglichen Antwortstatus, einschließlich Fehlern. Die Anfrage ist in cURL, Node.js, Python, Go, PHP, Ruby, Java, C# und PowerShell ausgeführt; Try it sendet sie mit dem eingefügten Schlüssel an die Live-API.
Die Referenz wird aus dem Kunden-OpenAPI-Dokument der API erzeugt, das die mit einem Organisations-API-Schlüssel aufrufbaren Vorgänge beschreibt. Laden Sie es als JSON herunter, um einen Client zu erzeugen oder es in ein API-Werkzeug zu importieren.
Endpunktgruppen
| Bereich | Gruppe | Inhalt |
|---|---|---|
| Bare Metal | Server | Server auflisten, mit stündlicher Abrechnung erstellen, umbenennen, sperren und löschen; Status, Abonnement und virtuelle Netzwerke jedes Servers |
| Strom | Strombefehle, BMC-Reset, Netzteil-, Temperatur- und Stromwerte | |
| Vorgänge | Betriebssystemimages und Anwendungen, Bereitstellungen, Hardwaretests und deren Abbruch | |
| Fernzugriff | Konsolensitzungen und virtuelle Medien | |
| Start und iPXE | Eigenes iPXE-Skript und Startmodus | |
| Dienst-ISOs | Vom Server einbindbare ISOs und welche davon eingebunden sind | |
| Netzwerke | Ports, Segmente und Sicherheitsscanergebnisse | |
| Bandbreite | Tägliche Übertragung gegenüber dem monatlichen Kontingent und Verlauf der Datenrate | |
| Aktivität | Prüfprotokoll eines Servers | |
| Netzwerke | Virtuelle Netzwerke | Netzwerke erstellen, VLAN-Tags, Server verbinden und trennen |
| IP-Blöcke | Blöcke und deren Adressen auflisten, Block hinzufügen oder zurückgeben | |
| IP-Adressen | Adressen zuweisen, reservieren und freigeben; Reverse DNS für IPv4 | |
| Sicherheitsscans | Befunde, Ziele und erneute Scans | |
| Abrechnung | Bestellungen | Bestellungen aufgeben und lesen |
| Abonnements | Verlängerungsstatus und Kündigung | |
| Rechnungen | Rechnungen lesen, bezahlen und herunterladen | |
| Nutzung | Gebühren im aktuellen Zeitraum | |
| Guthaben und Zahlungsmethoden | Kontoguthaben und gespeicherte Karten | |
| Katalog | Tarife | Bare-Metal- und IP-Block-Tarife mit Preisen und Bestand |
| Regionen | Rechenzentren, in denen Dienste bestellt werden können, mit ihren Codes | |
| Organisation | Berechtigte Funktionen | Für die Organisation aktivierte Limits und Funktionen, darunter stündliche Abrechnung |
| SSH-Schlüssel | Auf neuen Servern zu installierende öffentliche Schlüssel | |
| Aktivität | Prüfprotokoll der Organisation | |
| Ressourcen | ISO-Bibliothek | Die über virtuelle Medien eingebundenen ISOs hochladen und löschen |
kanadisch und 
niederländisch
