Erste Schritte mit Ootbi REST-APIs

Die meisten Menschen verwalten ihre Ootbi(s) über die Weboberfläche, und das aus gutem Grund: Sie ist Unkompliziert und schnell. Aber jedes Ootbi verfügt auch über eine vollständige REST-API, und sie bekommt deutlich weniger Aufmerksamkeit als die UI.

Laut Geoff Burke, Senior Technology Advisor, ist das eine verpasste Chance. Die API ermöglicht Automatisierung, Integrationen mit den Tools, die Sie bereits verwenden, und ist eine Möglichkeit, Ootbi in großem Maßstab zu verwalten, mit der sich das Durchklicken von Bildschirmen nicht messen kann. Es gibt viele weitere Funktionen, die in der UI ausgeführt werden können, z. B. Benutzer anlegen, den Clusterzustand prüfen, Ereignisse überprüfen oder Buckets auflisten; das können Sie auch programmatisch erledigen.

In diesem Leitfaden erklärt Geoff Burke, was die Ootbi REST-API ist und warum sie wichtig ist. Anschließend zeigt er, wie Sie eine Verbindung zu einem kostenlosen Open-Source-API-Client zu Ootbi herstellen und Ihre ersten API-Aufrufe ausführen.

Die Rolle von REST-APIs im heutigen IT-Betrieb

Über die Weboberfläche hinaus

Die Weboberfläche ist dafür gebaut, dass eine Person ein System verwaltet. Das funktioniert, bis der Aufwand wächst. Angenommen, Sie müssen 15 Benutzerkonten anlegen, jeden Morgen den Update-Status jeder Appliance prüfen oder jede Woche denselben Bericht für einen Auditor ausführen. Dann wird die UI zu einer Abfolge repetitiver Klicks.

Eine REST-API lässt ein anderes Programm diese Arbeit für Sie erledigen. Ihr Skript oder Ihre Anwendung sendet eine Anfrage an Ootbi, das strukturierte Daten zurückgibt, und dann entscheiden Sie, was als Nächstes passiert. Dadurch entfällt das Klicken und Kopieren von Werten aus Bildschirmen, und manuelle Eingabefehler werden reduziert.

Die Aufrufe müssen übrigens nicht von der Appliance kommen. Sie können von einem Laptop, einem zentralen Management-Server oder jedem System in Ihrem Netzwerk kommen, das den Ootbi-Cluster erreichen kann.

Häufige Gründe, warum Kunden APIs nutzen

• Betriebliche Effizienz: Automatisieren Sie die repetitiven Aufgaben, die Administratoren Zeit kosten.

• Funktionalität testen: Prüfen Sie Änderungen und neue Workflows in einem Labor-Cluster, bevor Sie sie in die Produktion ausrollen.

• Integration in bestehende Tools: Speisen Sie Ootbi-Daten in die Monitoring-, Ticketing- und Sicherheit-Plattformen ein, die Sie bereits verwenden.

• Reporting und Compliance: Ziehen Sie Benutzerlisten, Zugriffsschlüssel und Ereignisdaten bei Bedarf in einem konsistenten Format.

• Orchestrierung mehrerer Systeme: Große Organisationen und Service Provider bauen häufig eine interne Anwendung, die die APIs aller Produkte zusammenführt, die sie betreiben – Hardware und Software.

Praxisnahe Ootbi API-Anwendungsfälle

Administrative Aufgaben in großem Maßstab automatisieren

• Benutzerverwaltung: Die API bietet dieselben Optionen zur Benutzererstellung wie die UI, einschließlich derselben Rollen. Der Unterschied ist, dass Sie Benutzer programmatisch anlegen können, zum Beispiel aus Ihrem Identity-Management-Prozess heraus, statt einzeln.

• Zustandsprüfungen: Anfragen nach Cluster- und Node-Informationen liefern detaillierte Daten, einschließlich der auf dem Cluster laufenden Ootbi-Services und ihrer Versionen.

• Konfigurationsvalidierung: Eine Bucket-Auflistung zeigt Einstellungen wie z. B., ob Versionierung aktiviert ist. Versionierung ist standardmäßig aktiviert, aber eine geplante Prüfung kann bestätigen, dass niemand sie deaktiviert hat.

• Cluster-Administration: Rufen Sie Cluster-Einstellungen, Lizenzinformationen und das Cluster-Zertifikat ab, ohne in der UI irgendetwas manuell exportieren zu müssen.

Ein Beispiel sticht heraus: Die API kann aktuell verfügbare Updates für einen Cluster oder für einzelne Nodes zurückgeben. Wenn Ihre Organisation ein zentrales System zur Update-Nachverfolgung betreibt, können Sie Ootbi damit verbinden. Es meldet seine aktuelle Version und alle verfügbaren Updates zusammen mit allem anderen in Ihrer Umgebung. Das ist wichtiger denn je: Angreifer verwandeln neu veröffentlichte Schwachstellen schneller denn je in funktionierende Exploits – jedes ungepatchte System ist daher ein Ziel.

Integrationen für Monitoring und Alarmierung

Der Events-Endpunkt von Ootbi gibt jedes Ereignis mit seiner ID, Quelle, Schweregrad und Details zurück – alles als strukturiertes JSON. Dadurch lassen sich die Daten leicht an Plattformen senden wie:

• Splunk oder ein anderes SIEM, für Sicherheit-Transparenz

• PagerDuty, zur Alarmierung bei Ereignissen mit hohem Schweregrad

• ServiceNow, zum automatischen Erstellen von Tickets

• Grafana, für Dashboards

Zusammen machen diese Ootbi zu einem Bestandteil einer Single-Pane-of-Glass-Sicht auf Ihre Infrastruktur, statt zu einer separaten Konsole, die man prüfen muss.

Compliance- und Audit-Reporting

• Audit-Daten sammeln: Ziehen Sie Listen der Management-Benutzer und ihrer Rollen, aktive Sessions und Zugriffsschlüssel, einschließlich des Zeitpunkts, wann jeder Schlüssel zuletzt ausgegeben wurde.

• Compliance-Reports erstellen: Führen Sie dieselben Aufrufe nach Zeitplan aus und erzeugen Sie konsistente Reports ohne Screenshots oder manuelle Exporte.

• Regulierte Umgebungen unterstützen: Wenn ein Auditor fragt, wer Zugriff auf Ihren Backup-Speicher hat und auf welcher Ebene, können Sie mit Daten antworten, die direkt aus dem System gezogen wurden.

Transparenz bei Zugriffsschlüsseln ist selbst in kleinen Umgebungen wichtig. In einem stark genutzten Labor, in dem viele Personen Schlüssel erstellen, zeigt ein einzelner API-Aufruf jeden Schlüssel und wann er erstellt wurde – so basiert das Aufräumen auf Fakten statt auf Vermutungen.

MSP- und Multi-Tenant-Management

Service Provider verwalten viele Produkte über viele Kunden hinweg. Ein gängiger Ansatz ist, eine interne Anwendung auf Basis der API jedes Herstellers zu bauen. Aus dieser Anwendung heraus kann das Team Konten anlegen, Storage-Buckets bereitstellen und Informationen sammeln, ohne sich separat in jedes System einzuloggen.

• Mehrere Kundendeployments verwalten: Fragen Sie das Ootbi jedes Kunden aus einem zentralen Tool ab.

• Individuelle Management-Portale erstellen: Erstellen Sie maßgeschneiderte Ansichten, z. B. ein Portal für Junior-Administratoren, das nur bestimmte Funktionen bereitstellt.

• Operativer Overhead reduzieren: Standardisieren Sie Provisionierung und Reporting über jedes Deployment hinweg.

Die Ootbi API mit Swagger erkunden

Auf Swagger zugreifen

Jedes Ootbi enthält integrierte API-Dokumentation auf Basis von Swagger, einem Tool, das eine API als interaktive Webseite darstellt. Daran ist nichts verborgen. Jeder mit einem Ootbi kann sie öffnen, indem er /swagger/index.html an die Cluster-Adresse anhängt:

https://<your-Ootbi-cluster-address>:8443/swagger/index.html

Swagger-Startseite

Swagger listet jeden verfügbaren Endpunkt auf, nach Bereichen gruppiert, darunter Benutzer, Cluster, Nodes, Buckets, Zugriffsschlüssel, Ereignisse und Updates. Jeder ist mit seiner HTTP-Methode gekennzeichnet:

• GET ruft Informationen ab, z. B. eine Liste von Benutzern.

• POST sendet Informationen, z. B. die Details eines neuen Benutzers.

Für jeden Endpunkt zeigt Swagger die erwartete Anfrage und die zurückgegebene Antwort. Sie können auch auf Try it out klicken, um eine Anfrage direkt aus dem Browser auszuführen.

Swagger stellt außerdem die vollständige API-Definition als einzelne herunterladbare JSON-Datei bereit. Entwickler können darin suchen, sie in andere Tools importieren oder sie einem KI-Assistenten geben, um zu erkunden, was sie bauen könnten.

Beispiel-Link für Swagger-JSON: https://192.168.0.172:8443/swagger/v1/swagger.json

Ersetzen Sie die Beispiel-Cluster-ID durch die IP-Adresse Ihres eigenen Clusters.

 

Herausforderungen beim browserbasierten API-Testen

Swagger ist hervorragend zum Durchsuchen, aber für echte Arbeit weniger praktisch:

• Reibung bei der Authentifizierung: Bevor Sie eine Anfrage ausführen, rufen Sie den Login-Endpunkt mit Benutzername und Passwort auf, kopieren das zurückgegebene Bearer-Token und fügen es in Swaggers Authorize-Dialog ein.

• Einschränkungen beim Session-Management: Aus Sicherheit-Gründen sind Ootbi-Tokens kurzlebig. Sie laufen schnell ab, und Sie müssen den Prozess wiederholen – oft mitten in dem, was Sie gerade tun.

• Fehlende wiederverwendbare Workflows: Swagger speichert Ihre Werte oder Anfragen nicht. Jede Session beginnt bei null.

Deshalb verwenden wir einen Dediziert API-Client.

Mit der Ootbi API in einem API-Client arbeiten

Sie können jeden API-Client verwenden, um mit der Ootbi API zu arbeiten. Die folgenden Schritte sind allgemeine Anweisungen, um einen API-Client mit Ootbi zu verbinden. Bitte beachten Sie, dass Menünamen und Optionen je nach Client variieren können; prüfen Sie daher die Dokumentation Ihres Clients für Details.

Was Ihnen ein API-Client beim Testen von Ootbi bietet

• Gespeicherte Authentifizierungseinstellungen: Richten Sie die Anmeldung einmal ein und verwenden Sie sie für jede Anfrage wieder.

• Automatische Token-Aktualisierung: Ein kurzes Skript kann ein neues Token abrufen und es automatisch erneuern, sodass kurze Token-Lebensdauern Ihre Arbeit nicht unterbrechen.

• Sammlungen und Umgebungen: Importieren Sie die gesamte Ootbi-API als durchsuchbare Sammlung und nutzen Sie Umgebungen, um zwischen Labor- und Produktions-Clustern zu wechseln.

• Schnelleres Testen: Ändern Sie einen Wert, klicken Sie auf Senden, und sehen Sie das Ergebnis. Kein Kopieren von Tokens mehr zwischen Tabs.

Gängige API-Clients

Hier sind drei weit verbreitete API-Clients, in alphabetischer Reihenfolge aufgeführt. Es sind Beispiele, keine Empfehlungen. Wählen Sie den Client, der am besten zu den Anforderungen Ihres Teams und den Sicherheit-Richtlinien passt.

Bruno

Bruno ist ein schlanker, lokal ausgerichteter API-Client zum Erstellen und Testen von API-Anfragen. Er ist kostenlos und Open Source. Sammlungen werden als Klartextdateien auf Ihrem eigenen Rechner gespeichert, sodass Sie Anfragen in Git unter Versionskontrolle halten und über Ihre bestehenden Repositories teilen können. Bruno importiert OpenAPI-(Swagger-)Dateien und unterstützt Umgebungen, geheime Variablen und Skripting.

Insomnia

Entwickelt von Kong ist Insomnia ein plattformübergreifender API-Client, der für seine aufgeräumte, intuitive Oberfläche bekannt ist. Wie Bruno ist er kostenlos und Open Source. Er beherrscht viele Protokolle, darunter REST, GraphQL, gRPC und WebSockets, und Sie können Projekte lokal speichern, mit Git synchronisieren oder in der Cloud ablegen. Insomnia importiert ebenfalls OpenAPI-(Swagger-)Dateien und ergänzt Plugins für benutzerdefinierte Workflows.

Postman

Als eine der am weitesten verbreiteten API-Plattformen bietet Postman Teams einen zentralen Ort, um APIs zu entwerfen, zu testen, zu dokumentieren und zu überwachen. Es ist kostenlos für macOS, Windows und Linux herunterzuladen und läuft auch im Webbrowser. Postman unterstützt OpenAPI-(Swagger-)Importe, Umgebungen, Pre-Request- und Test-Skripte sowie automatisierte Sammlungsdurchläufe. Seine gemeinsamen Arbeitsbereiche erleichtern die Zusammenarbeit im Team.

Ihren API-Client mit Ootbi verbinden

Schritt 1: Einen API-Client installieren

Jeder Client hat seinen eigenen Authentifizierungsprozess, der die Swagger-JSON-Datei importieren können sollte.

Schritt 2: Konnektivität testen

Führen Sie eine Unkompliziert-Anfrage aus, zum Beispiel die, die aktive Sitzungen zurückgibt. Ein 200-Statuscode bedeutet, dass Ootbi Ihr Token akzeptiert und die Verbindung funktioniert. Die Antwort listet die aktuellen Sitzungen auf dem Cluster auf, einschließlich Ihrer eigenen.

Ihre ersten Ootbi-API-Aufrufe ausführen

Beispiel 1: Cluster-Informationen abrufen

Senden Sie die Anfrage Allgemeine Informationen zu Clustern abrufen. Die Antwort ist detailliert: Neben den Cluster- und Node-Details listet sie die auf dem Cluster laufenden Ootbi-Dienste und deren Versionen auf – Informationen, die Sie in der Benutzeroberfläche nicht an einer Stelle finden.

Beispiel 2: Auf verfügbare Updates prüfen

Senden Sie die Anfrage derzeit verfügbare Updates unter Verwendung Ihrer Cluster-Id. Die Antwort zeigt Ihre aktuelle Version und jede verfügbare Version.

In der Praxis würde ein zentrales Tool zur Update-Überwachung diesen Aufruf nach Zeitplan ausführen, die aktuelle Version speichern und markieren, wenn ein Update verfügbar wird. Es gibt auch eine Node-spezifische Variante dieser Anfrage, die hilft, in einem Multi-Node-Cluster einen Node zu erkennen, der zurückgefallen ist.

Beispiel 3: Benutzer- und Ereignisdaten abrufen

Für ein Compliance-orientiertes Beispiel probieren Sie zwei Anfragen aus:

• Gibt Liste der Verwaltungsbenutzer zurück: Gibt jeden Verwaltungsbenutzer mit seiner Rolle und Zugriffsebene zurück. Erstellen Sie in der Benutzeroberfläche einen neuen schreibgeschützten Benutzer (Rolle Monitoring), führen Sie die Anfrage erneut aus, und der neue Benutzer erscheint sofort – eine schnelle Möglichkeit zu sehen, dass API und Benutzeroberfläche dieselben Daten anzeigen.

• Ereignisse: Gibt Ereignisse mit ihrer ID, Quelle, Schweregrad und Details zurück. Das sind dieselben Informationen, die Sie aus Syslog erhalten würden, jedoch als strukturiertes JSON, das kein Parsing benötigt. Es ist bereit für die Übergabe an ein SIEM oder ein Reporting-Tool.

Weiterführend: Integrationen erstellen

Ootbi-Daten in ein SIEM exportieren

Ihr Sicherheit-Team möchte Backup-Infrastrukturereignisse zusammen mit allem anderen. Ein Unkompliziert-Workflow:

1. Ein Skript auf Ihrem Collector-Server authentifiziert sich bei Ootbi und fordert Ereignisse nach Zeitplan an.
2. Es behält nur neue Ereignisse seit dem letzten Lauf.
3. Es leitet sie an Ihr SIEM weiter, wo sie korreliert, durchsucht und für Alarme genutzt werden können.

Automatisierte Berichte erstellen

Derselbe Ansatz ermöglicht geplantes Reporting. Ziehen Sie wöchentlich Benutzer, Zugriffsschlüssel, Buckets (einschließlich Versionierungsstatus) und Lizenzinformationen und verwandeln Sie die Ergebnisse in einen konsistenten Bericht oder ein Dashboard, das Ihr Team jeden Tag prüft.

In bestehende IT-Workflows integrieren

• Ticketing-Systeme: Öffnen Sie automatisch ein Ticket, wenn ein Ereignis mit hohem Schweregrad erscheint oder ein Update verfügbar wird.

• Monitoring-Plattformen: Fügen Sie Ootbi-Zustands- und Kapazitätsdaten zu den Dashboards hinzu, die Ihr Betriebsteam bereits nutzt.

• Interne Tools: Integrieren Sie Ootbi in Ihr Provisionierungsportal, um beispielsweise beim Onboarding eines neuen Teams oder Kunden Benutzer oder Buckets anzulegen.

Mit KI-Coding-Assistenten ist das Erstellen dieser kleinen Integrationen einfacher denn je, selbst wenn Sie sich nicht als Entwickler sehen.

Fazit

Die Ootbi-REST-API erweitert Ootbi weit über die Weboberfläche hinaus. Sie ist in jedes Appliance integriert, über Swagger dokumentiert und für jeden verfügbar, der ein Ootbi besitzt. Stellen Sie sicher, dass Sie einen API-Client wählen, der sich leicht erkunden, testen und schließlich zur Automatisierung API-gesteuerter Workflows nutzen lässt.

Ob Sie IT-Administrator, Entwickler, MSP oder ein Sicherheit-Team sind: Die Ootbi-API kann Ihnen helfen, Abläufe zu optimieren, die Transparenz zu verbessern und Ihre Backup-Infrastruktur in Ihre bestehenden Unternehmensprozesse einzubinden. Öffnen Sie Swagger auf Ihrem Cluster und sehen Sie, was Sie bauen können.