FAQ: API Schnitstelle zu Cloud Server 4.0

Was umfasst die erste Version des öffentlichen API-Zugangs und was kommt als Nächstes?

Mit dem neuen öffentlichen API-Zugang öffnen wir unsere Dienste erstmals für eine programmatische Nutzung von außen. In der ersten Iteration stellen wir Ihnen einen Rest-API Endpoint bereit, der die wichtigsten Funktionen bereits jetzt abbildet und flexible, schema-basierte Abfragen ermöglicht. 

Wo erstelle ich einen Token und wo finde ich die Dokumentation?

Sie finden die API-Dokumentation und die Token-Generierung im Bereich „API-Zugriff“ im oneHome.
 

Wie authentifiziert sich ein Client an der API?
Der Client authentifiziert sich, indem er bei jeder Anfrage sein Bearer-Token im HTTP-Header 

Authorization: Bearer <TOKEN> mit sendet.
  

Wie lange ist der API Token gültig?

• Standardmäßig beträgt die Gültigkeit 365 Tage.
• Alternativ haben Sie die Möglichkeit, die Gültigkeit selbst festzulegen.
   

Wie erneuere ich einen API-Token, bevor er nicht mehr gültig ist?

• Bisherigen Token in oneHome entfernen.
• Einen neuen API-Token erstellen.
• Den neuen API-Token im Client aktualisieren.
   

Wie lautet die Base URL der API?

• https://onehome.dogado.de/api/v1
   

Welche Funktionen kann ich über die API ausführen?

Bitte beachten Sie, dass nicht alle Funktionen, die in der API-Dokumentation aufgeführt sind, derzeit für Endkunden bei dogado verfügbar sind. Aktuell können Sie folgende Optionen nutzen:
 

• Liste der eigenen Server (“Cloud Server 4.0”)
  • /servers
• Details zu Servern abrufen
  • /servers/{id} (Mit id ist nicht die Vertragsnummer gemeint, ie id entnehmen Sie aus der Abfrage /servers)
• Aktionen für Server ausführen
  • Soft Reboot
    • /servers/{id}/soft-reboot
  • Hard Reboot
    • /servers/{id}/hard-reboot
  • Reset
    • /servers/{id}/reset
  • Ausschalten
    • /servers/{id}/power-off
  • Anschalten
    • /servers/{id}/power-on
       

Welche Server oder Produkte kann ich via API administrieren?

• Cloud Server S 4.0
• Cloud Server M 4.0
• Cloud Server L 4.0
• Cloud Server XL 4.0
• Cloud Server XXL 4.0