Zum Hauptinhalt springen

OakHost Customer API

OakHost bietet eine API zum Zugriff auf und zur Manipulation Ihrer Ressourcen, wie Server-Informationen, Firewall und mehr. Dies ermöglicht es Ihnen, OakHost in Ihre eigenen Anwendungen oder Skripte zu integrieren. Die automatisierte Erstellung von Servern wird derzeit nicht unterstützt.

Sie können auf die Swagger-Endpunkt-Dokumentation zugreifen unter:

https://www.oakhost.net/api/documentation

info

Diese API befindet sich derzeit in der Beta-Phase und kann sich in Zukunft ändern. Um Zugang zu beantragen, öffnen Sie bitte ein Support-Ticket. Bitte melden Sie alle Probleme oder Vorschläge an unser Support-Team.

API-Übersicht#

Endpunkt#

Die Basis-URL für die API ist:

https://www.oakhost.net/api/cws

Authentifizierung#

Alle Anfragen erfordern Bearer-Token-Authentifizierung über den Authorization-Header. Ersetzen Sie [token] durch Ihren tatsächlichen Token. Der Token kann aus dem OakHost Kundenpanel bezogen werden.

Authorization: Bearer [token]

Content-Type#

Alle Anfragen müssen den JSON-Content-Type verwenden. Setzen Sie die folgenden Header in Ihren Anfragen:

Content-Type: application/json
Accept: application/json

Response-Codes#

  • 200 OK - Erfolg
  • 400 Bad Request - Ungültige Anfrage (z.B. fehlerhaftes JSON, ungültige Aktion)
  • 422 Unprocessable Entity - Validierungsfehler (z.B. fehlende Pflichtfelder)
  • 401 Unauthorized - Ungültiger oder fehlender Token
  • 403 Forbidden - Zugriff verweigert (z.B. unzureichende Berechtigungen)
  • 404 Not Found - Ressource nicht gefunden
  • 500 Internal Server Error - Server-Fehler

Endpunkte#

Für eine vollständige Liste der Endpunkte verweisen Sie bitte auf die Swagger-Dokumentation.