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:
| 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 Identifier-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. |
/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. |