Skip to main content

eEKAS REST API-Referenz

Die vollständige eEKAS REST API-Referenz beschreibt die Endpunkte, Parameter, curl-Beispiele und HTTP-Antworten für die Automatisierung Ihrer Installation.

Vollständige Referenz herunterladen

eEKAS REST API-Referenz herunterladen (HTML, Englisch). Die Datei ist auch als Anhang dieser Seite verfügbar. Laden Sie die Datei herunter und öffnen Sie sie im Browser. Sie enthält ein Inhaltsverzeichnis und kann mit der Browsersuche durchsucht werden.

Ausgabe: 8. Oktober 2026 · Referenzversion: 1.0.0 · Umfang: 285 Operationen. Die curl-Beispiele dieser Ausgabe verwenden die Zertifikatsprüfung; bei einer privaten CA ergänzen Sie --cacert /pfad/ca.pem.

Vollständiges API-Dokumentationspaket herunterladen (ZIP, Englisch): Referenz, S3-Abläufe, Kunden- und Abrechnungsleitfaden sowie OpenAPI JSON und YAML. Entpacken Sie alle Dateien gemeinsam und öffnen Sie eekas.html. Die S3-Abläufe erläutern die Anfragekörper und Bestätigungen für Sicherung und Wiederherstellung.

Für die Einrichtung und erste Abfrage lesen Sie REST API – Einstieg und Automatisierung.

Bereiche

  • API-Grundfunktionen, Benutzer und System
  • Cluster, Ceph, Freigaben und Speicherverwaltung
  • iSCSI, Fibre Channel, NVMe und Initiatoren
  • S3-Dienste, Object Storage, Replikation, Sicherung und Wiederherstellung
  • S3-Kunden, Nutzung und Abrechnung

Referenz Ihrer installierten Version

Prüfen Sie die verfügbaren Operationen anhand der OpenAPI-Spezifikation Ihrer Installation. Wenn die API-Dokumentation aktiviert ist, stehen am konfigurierten API-Endpunkt /api/docs für Swagger UI und /api/openapi.json beziehungsweise /api/openapi.yaml für OpenAPI zur Verfügung. Der Zugriff benötigt einen gültigen API-Schlüssel. Der Standardendpunkt ist https://<server>:18443.

Die herunterladbare Referenz ist ein Versionsstand. Funktionen und Parameter Ihrer Installation können davon abweichen. Die Verwaltung über diese REST API ist vom S3-Protokoll für Objektzugriffe zu unterscheiden.

Verwendung und Support

Die Nutzung der API erfolgt in eigener Verantwortung. API-Nutzung ist nicht durch den Support abgedeckt. Prüfen Sie Änderungen zuerst in einer Testumgebung und beachten Sie die Voraussetzungen der jeweiligen Funktion im Handbuch.

S3-Abläufe direkt in BookStack