Demo Starten

Spezifizieren Sie benutzerdefinierte Gerätemarken und -modelle über die REST-API

Mit der ExtraHop REST API können Sie kundenspezifische Marken und Modelle für Geräte angeben. Sie können Geräte über den REST API Explorer aktualisieren oder den Vorgang automatisieren, indem Sie Gerätekriterien über ein REST-API-Skript aus einer CSV- oder ähnlichen Datei lesen.

Before you begin

  • Für Sensoren und ECA-VMs benötigen Sie einen gültigen API-Schlüssel, um Änderungen über die REST-API vornehmen und die folgenden Verfahren ausführen zu können. (siehe Generieren Sie einen API-Schlüssel.)
  • Für Reveal (x) 360 benötigen Sie gültige REST-API-Anmeldeinformationen, um Änderungen über die REST-API vornehmen und die folgenden Verfahren ausführen zu können. (siehe REST-API-Anmeldeinformationen erstellen.)

Geben Sie eine benutzerdefinierte Marke und ein Modell über den REST API Explorer an

Rufen Sie die ID des Gerät ab

Bevor Sie eine benutzerdefinierte Marke und ein Modell für ein Gerät angeben können, müssen Sie die REST-API-ID des Gerät abrufen.

  1. Navigieren Sie in einem Browser zum REST API Explorer.
    Die URL ist der Hostname oder die IP-Adresse Ihres Sensor oder Konsole, gefolgt von /api/v1/explore/. Wenn Ihr Hostname beispielsweise seattle-eda ist, lautet die URL https://seattle-eda/api/v1/explore/.
  2. klicken Geben Sie den API-Schlüssel ein und fügen Sie dann Ihren API-Schlüssel ein oder geben Sie ihn in das API-Schlüssel Feld.
  3. klicken Autorisieren und dann klicken Schliessen.
  4. klicken POST /Geräte/Suche.
  5. klicken Probiere es aus.
    Das JSON-Schema wird automatisch dem Textfeld für den Body-Parameter hinzugefügt.
  6. Geben Sie in das Textfeld die Suchkriterien ein, mit denen das Gerät ausgewählt wird.
    Die folgenden Suchkriterien geben ein Gerät mit der IP-Adresse 10.10.10.200 zurück:
    {
  "filter": {
    "field": "ipaddr",
    "operand": "10.10.10.200",
    "operator": "="
  }
}

    Weitere Informationen zu Gerätesuchfiltern finden Sie unter Operandenwerte für die Gerätesuche.

  7. klicken Anfrage senden.
    Beachten Sie im Abschnitt Antworttext den id Feld des Gerät.

Geben Sie ein hoher Wert Gerät an

  1. klicken PATCH /Geräte/ {id}.
  2. klicken Probiere es aus.
  3. In der Körper Feld, geben Sie das folgende JSON-Objekt ein: 
    {
    "custom_criticality": "critical"
}
  4. In der id Feld, geben Sie die ID des Gerät, das Sie haben im vorherigen Verfahren abgerufen.
  5. klicken Anfrage senden.
    Wenn die Anfrage erfolgreich ist, wird im Abschnitt Serverantwort der Antwortcode 204 angezeigt.

Rufen Sie das Python-Beispielskript ab und führen Sie es aus

Das ExtraHop GitHub-Repository enthält ein Beispiel-Python-Skript, das Sonderanfertigungen und Modelle aus einer CSV-Datei liest und sie Geräten mit angegebenen IP-Adressen hinzufügt.

  1. Gehe zum ExtraHop Codebeispiele GitHub-Repository und laden Sie den Inhalt des specify_custom_make_model Verzeichnis auf Ihrem lokalen Computer.
  2. Öffnen Sie in einem Texteditor den custom_config.csv hinterlegen und fügen Sie die IP-Adresse für jedes Gerät hinzu, das Sie aktualisieren möchten, zusammen mit den Sonderanfertigungen und Modellen für jedes Gerät.
    Hinweis:Die Datei enthält zwei Beispieleinträge. Das Script ignoriert die Kopfzeile.
  3. Öffnen Sie in einem Texteditor den specify_custom_make_model.py archivieren und ersetzen Sie die Konfigurationsvariablen durch Informationen aus Ihrer Umgebung.
    • Geben Sie für Sensoren und ECA-VMs die folgenden Konfigurationsvariablen an:

      GASTGEBER: Die IP-Adresse oder der Hostname des Sensor oder der ECA-VM.

      API_SCHLÜSSEL: Der API-Schlüssel.

    • Geben Sie für Reveal (x) 360 die folgenden Konfigurationsvariablen an:

      GASTGEBER: Der Hostname der Reveal (x) 360-API. Dieser Hostname wird auf der Reveal (x) 360 API Access-Seite unter API-Endpunkt angezeigt. Der Hostname beinhaltet nicht /oauth2/token.

      ID: Die ID der Reveal (x) 360-REST-API-Anmeldeinformationen.

      GEHEIM: Das Geheimnis der Reveal (x) 360 REST-API-Anmeldeinformationen.

  4. Führen Sie den folgenden Befehl aus: 
    python3 specify_custom_make_model.py
    Hinweis:Wenn das Skript eine Fehlermeldung zurückgibt, dass die SSL-Zertifikatsüberprüfung fehlgeschlagen ist, stellen Sie sicher, dass Ihrem Sensor oder Ihrer Konsole wurde ein vertrauenswürdiges Zertifikat hinzugefügt. Alternativ können Sie das hinzufügen verify=False Option zur Umgehung der Zertifikatsüberprüfung. Diese Methode ist jedoch nicht sicher und wird nicht empfohlen. Der folgende Code sendet eine HTTP GET-Anfrage ohne Zertifikatsüberprüfung:
    requests.get(url, headers=headers, verify=False)
Last modified 2024-03-20