Zugriff auf die interaktive API-Dokumentationsseite

Auf der interaktiven API-Dokumentationsseite können Sie auf technische Details für die REST-konformen APIs zugreifen und mit der Erstellung von API-Anforderungen an Ihren Server experimentieren.

Informationen zu dieser Task

Die Benutzerschnittstelle der API-Dokumentation stellt Beschreibungen bereit und ermöglicht die Verwendung der folgenden REST-API-Schnittstellen:
Tabelle 1 REST-API-Schnittstellen
REST-API Beschreibung
/api/analytics Zum Erstellen, Aktualisieren und Entfernen benutzerdefinierter Aktionen für Regeln.
/api/ariel Zum Anzeigen von Ereignis- und Datenflusseigenschaften, Erstellen von Ereignis- und Datenflusssuchen und Verwalten von Suchen.
/api/asset_model Gibt eine Liste aller Assets im Modell zurück. Sie können auch alle verfügbaren Asseteigenschaftstypen und gespeicherten Suchvorgänge auflisten und ein Asset aktualisieren.
/api/auth Zum Abmelden und Inaktivieren der aktuellen Sitzung.
/api/config Sie können Tenants, Domänen und QRadar -Erweiterungen anzeigen und verwalten.
/api/data_classification Alle übergeordneten und untergeordneten Kategorien, QRadar ID-Datensätze (QID) und Ereigniszuordnungen anzeigen. Sie können auch QID-Datensätze und -Zuordnungen erstellen oder bearbeiten.
/api/forensics Zum Verwalten von Erfassungswiederherstellungen und -fällen.
/api/gui_app_framework Zum Installieren und Verwalten von Anwendungen, die mit dem GUI Application Framework Software Development Kit erstellt werden.
/api/help Gibt eine Liste der API-Leistungsmerkmale zurück.
/api/qrm Zum Verwalten von gespeicherten QRM-Suchgruppen, Fragengruppen, Simulationsgruppen, gespeicherten Topologiesuchgruppen und Modellgruppen.
/api/qvm Ruft Assets, Schwachstellen, Netze, Open Services und Filter ab. Sie können auch Korrekturtickets erstellen oder aktualisieren.
/api/reference_data Zum Anzeigen und Verwalten von Referenzdatensammlungen.
/api/scanner Zum Anzeigen, Erstellen oder Starten eines fernen Scans, dem ein Scanprofil zugeordnet ist.
Wichtig: Der IBM QRadar Vulnerability Manager -Scanner ist das Ende des Lebenszyklus (EOL) in 7.5.0 Update Package 6 und wird in keiner Version von IBM QRadarmehr unterstützt. Weitere Informationen finden Sie unter QRadar Vulnerability Manager: End of service product notification (https://www.ibm.com/support/pages/node/6853425).
/api/services Zum Ausführen von Tasks wie WHOIS-, Portscan-, DNS- und DIG-Suchen. Sie können auch Geodaten für IP-Adressen oder IP-Adressgruppen abrufen.
/api/siem Zum Anzeigen, Aktualisieren und Schließen von Angriffen. Außerdem können Anmerkungen hinzugefügt und Gründe für das Schließen von Angriffen verwaltet werden.
/api/staged_config Zum Abrufen von Staging-Konfigurationen für Benutzer, Hosts, Benachrichtigungen, ferne Netze und ferne Services. Sie können auch eine Implementierungsaktion initiieren oder deren Status anzeigen und Yara-Regeln aktualisieren oder löschen.
/api/system Zum Verwalten von Server-Hosts, Netzschnittstellen und Firewallregeln.

Vorgehensweise

  1. Um auf die interaktive API-Dokumentationsschnittstelle zuzugreifen, geben Sie Folgendes in Ihren Webbrowser ein: URL https://ConsoleIPaddress/api_doc/.
  2. Wählen Sie in der Liste die zu verwendende API-Version aus.
  3. Gehen Sie zu dem Endpunkt, auf den Sie zugreifen möchten.
  4. Lesen Sie die Endpunktdokumentation und vervollständigen Sie die Anforderungsparameter.
  5. Klicken Sie auf "Ausprobieren ", um die API-Anfrage an Ihre Konsole zu senden und eine korrekt formatierte Antwort von HTTPS zu erhalten.
    Anmerkung: Wenn Sie auf Ausprobierenklicken, wird die Aktion auf dem QRadar -System ausgeführt. Nicht alle Aktionen können zurückgenommen werden, z. B. können Sie einen Angriff nicht erneut öffnen, nachdem Sie ihn geschlossen haben.
  6. Überprüfen und sammeln Sie die Informationen, die Sie für die Integration mit QRadarbenötigen.