Leitfaden zur REVEAL (x) 360 REST-API

POST /activitymaps

Geben Sie die folgenden Parameter an.

body: Objekt

Die Eigenschaften der Aktivitätsdiagramm.

name: Schnur

Der freundliche Name für die Aktivitätsdiagramm.

short_code: Schnur

(Optional) Der eindeutige Kurzcode, der global für alle Activity Maps gilt.

description: Schnur

Die Beschreibung für die Aktivitätsdiagramm.

weighting: Schnur

(Optional) Der Metrikwert, der bestimmt, wie Aktivitäten zwischen Geräten gewichtet werden. Unterstützte Elementwerte sind „Bytes", „Verbindungen" und „Turns".

mode: Schnur

(Optional) Das Layout der Aktivitätsdiagramm. Unterstützte Werte sind „2dforce" und „3dforce".

show_alert_status: Boolescher Wert

(Optional) Gibt an, ob der Alarmstatus für Geräte auf der Aktivitätsdiagramm werden soll. Wenn diese Option aktiviert ist, steht die Farbe jedes Geräts auf der Karte für die schwerwiegendste Warnstufe, die dem Gerät zugeordnet ist.

walks: Reihe von Objekten

Die Liste von einem oder mehreren Wanderobjekten. Ein Spaziergang ist ein Verkehrsweg, der aus einer oder mehreren Stufen besteht. Jeder Walk beginnt mit einem oder mehreren Ursprungsgeräten und erweitert sich auf Verbindungen zu Peer-Geräten, die auf Protokollaktivitäten basieren. Jede Erweiterung vom Ursprung aus ist ein Schritt. Der Inhalt des Objekts wird im Abschnitt „Gehen" unten definiert.

origins: Reihe von Objekten

Die Liste eines oder mehrerer Ursprungsgeräte des ersten Schritts innerhalb des Spaziergangs. Der Objektinhalt wird im Abschnitt „source_object" unten definiert.

object_type: Schnur

Der Quelltyp der Metrik.

Die folgenden Werte sind gültig:

• device
• device_group

object_id: Zahl

Der eindeutige Bezeichner für das Quellobjekt.

steps: Reihe von Objekten

Die Liste von einem oder mehreren Schritten innerhalb des Spaziergangs. Jeder Schritt wird durch die Protokollaktivität zwischen Geräten des vorherigen Schritts und einer neuen Gruppe von Peer-Geräten definiert. Der Objektinhalt wird im Abschnitt „Schritt" unten definiert.

relationships: Reihe von Objekten

(Optional) Die Liste mit einem oder mehreren Filtern, die die Beziehung zwischen zwei Geräten definieren. Die Filter geben an, nach welchen Rollen und Protokollen gesucht werden soll, wenn Peer-Geräte in diesem Schritt gefunden werden. Beziehungen werden in der Aktivitätsdiagramm als Rand dargestellt. Objektinhalte werden im Abschnitt „Beziehung" weiter unten definiert. Wenn kein Wert angegeben ist, sucht der Vorgang nach allen Peers.

protocol: Schnur

(Optional) Das mit der Beziehung verknüpfte Metrikprotokoll, z. B. „HTTP" oder „DNS". Der Vorgang sucht nur nach Verbindungen zwischen Geräten über das angegebene Protokoll.

role: Schnur

(Optional) Die Geräterolle, die dem Metrik Protokoll der Beziehung zugeordnet ist. Der Vorgang sucht nur nach Verbindungen zwischen Geräten über das zugehörige Protokoll in der angegebenen Rolle. Unterstützte Rollenwerte sind „Client", „Server" oder „Any". Auf „any" setzen, um alle Client-, Server- und Peer-Gerätebeziehungen zu finden, die dem angegebenen Protokoll zugeordnet sind.

peer_in: Reihe von Objekten

(Optional) Die Liste von einem oder mehreren Peer-Geräteobjekten, die in die Activity Map aufgenommen werden sollen. Nur Beziehungen zu Peers des angegebenen Quellobjekts sind enthalten. Der Objektinhalt wird im Abschnitt „source_object" unten definiert.

object_type: Schnur

Der Quelltyp der Metrik.

Die folgenden Werte sind gültig:

• device
• device_group

object_id: Zahl

Der eindeutige Bezeichner für das Quellobjekt.

peer_not_in: Reihe von Objekten

(Optional) Die Liste von einem oder mehreren Peer-Geräteobjekten, die von der Aktivitätsdiagramm ausgeschlossen werden sollen. Beziehungen zu Peers des angegebenen Quellobjekts sind ausgeschlossen. Der Objektinhalt wird im Abschnitt „source_object" unten definiert.

object_type: Schnur

Der Quelltyp der Metrik.

Die folgenden Werte sind gültig:

• device
• device_group

object_id: Zahl

Der eindeutige Bezeichner für das Quellobjekt.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "description": "string",
    "mode": "string",
    "name": "string",
    "short_code": "string",
    "show_alert_status": true,
    "walks": {
        "origins": {
            "object_type": "string",
            "object_id": 0
        },
        "steps": {
            "relationships": {
                "protocol": "string",
                "role": "string"
            },
            "peer_in": {
                "object_type": "string",
                "object_id": 0
            },
            "peer_not_in": {
                "object_type": "string",
                "object_id": 0
            }
        }
    },
    "weighting": "string"
}

Kopieren

POST /activitymaps/query

Geben Sie die folgenden Parameter an.

body: Objekt

Die Eigenschaften der Topologieabfrage.

from: Zahl

Der Anfangszeitstempel des Zeitbereichs, den die Abfrage durchsucht, ausgedrückt in Millisekunden seit der Epoche.

until: Zahl

(Optional) Der letzte Zeitstempel des Zeitbereichs, den die Abfrage durchsucht, ausgedrückt in Millisekunden seit der Epoche. Wenn kein Wert gesetzt ist, wird das Abfrageende standardmäßig auf „now" gesetzt.

weighting: Schnur

(Optional) Der Metrikwert, der bestimmt, wie Aktivitäten zwischen Geräten gewichtet werden.

Die folgenden Werte sind gültig:

• bytes
• connections
• turns

edge_annotations: Reihe von Zeichenketten

(Optional) Die Liste mit einer oder mehreren Kantenanmerkungen, die in die Topologieabfrage aufgenommen werden sollen.

Die folgenden Werte sind gültig:

• protocols
• appearances

walks: Reihe von Objekten

Die Liste von einem oder mehreren Walk-Objekten, die in die Topologieabfrage aufgenommen werden sollen. Ein Spaziergang ist ein Verkehrsweg, der aus einer oder mehreren Stufen besteht. Jeder Walk beginnt mit einem oder mehreren Ursprungsgeräten und erweitert sich auf Verbindungen zu Peer-Geräten, die auf Protokollaktivitäten basieren. Jede Erweiterung vom Ursprung aus ist ein Schritt. Der Objektinhalt wird im Abschnitt „topology_walk" unten definiert.

origins: Reihe von Objekten

Die Liste eines oder mehrerer Ursprungsgeräte des ersten Schritts innerhalb des Spaziergangs. Der Objektinhalt wird im Abschnitt „topology_source" unten definiert.

object_type: Schnur

Der Typ des Quellobjekts.

Die folgenden Werte sind gültig:

• all_devices
• device_group
• device

object_id: Zahl

Der eindeutige Bezeichner für das Quellobjekt. Auf 0 setzen, wenn der Wert des Parameter „object_type" „all_devices" ist.

steps: Reihe von Objekten

Die Liste von einem oder mehreren Schritten innerhalb des Spaziergangs. Jeder Schritt wird durch die Protokollaktivität zwischen Geräten des vorherigen Schritts und einer neuen Gruppe von Peer-Geräten definiert. Objektinhalte werden im Abschnitt „topology_step" unten definiert.

relationships: Reihe von Objekten

(Optional) Die Liste mit einem oder mehreren Filtern, die die Beziehung zwischen zwei Geräten definieren. Die Filter geben an, nach welchen Rollen und Protokollen gesucht werden soll, wenn Peer-Geräte in diesem Schritt gefunden werden. Beziehungen werden in der Aktivitätsdiagramm als Rand dargestellt. Wenn kein Wert festgelegt ist, umfasst die Operation alle Peers. Der Objektinhalt wird im Abschnitt „topology_relationship" weiter unten definiert.

role: Schnur

(Optional) Die Rolle des Peer-Geräts im Verhältnis zum Ursprungsgerät.

Die folgenden Werte sind gültig:

• client
• server
• any

protocol: Schnur

(Optional) Das Protokoll, über das das Ursprungsgerät kommuniziert, z. B. „HTTP". Wenn kein Wert festgelegt ist, enthält das Objekt ein beliebiges Protokoll.

peer_in: Reihe von Objekten

(Optional) Die Liste von einem oder mehreren Peer-Geräten, die in das Topologiediagramm aufgenommen werden sollen. Nur Beziehungen zu Peers des angegebenen Quellobjekts sind enthalten. Der Objektinhalt wird im Abschnitt „topology_source" unten definiert.

object_type: Schnur

Der Typ des Quellobjekts.

Die folgenden Werte sind gültig:

• all_devices
• device_group
• device

object_id: Zahl

Der eindeutige Bezeichner für das Quellobjekt. Auf 0 setzen, wenn der Wert des Parameter „object_type" „all_devices" ist.

peer_not_in: Reihe von Objekten

(Optional) Die Liste von einem oder mehreren Peer-Geräten, die aus dem Topologiediagramm ausgeschlossen werden sollen. Beziehungen zu Peer-Geräten des angegebenen Quellobjekts sind ausgeschlossen. Der Objektinhalt wird im Abschnitt „topology_source" unten definiert.

object_type: Schnur

Der Typ des Quellobjekts.

Die folgenden Werte sind gültig:

• all_devices
• device_group
• device

object_id: Zahl

Der eindeutige Bezeichner für das Quellobjekt. Auf 0 setzen, wenn der Wert des Parameter „object_type" „all_devices" ist.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "edge_annotations": [],
    "from": 0,
    "until": 0,
    "walks": {
        "origins": {
            "object_type": "string",
            "object_id": 0
        },
        "steps": {
            "relationships": {
                "role": "string",
                "protocol": "string"
            },
            "peer_in": {
                "object_type": "string",
                "object_id": 0
            },
            "peer_not_in": {
                "object_type": "string",
                "object_id": 0
            }
        }
    },
    "weighting": "string"
}

Kopieren

GET /activitymaps

Für diesen Vorgang gibt es keine Parameter.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "description": "string",
    "id": 0,
    "mod_time": 0,
    "mode": "string",
    "name": "string",
    "owner": "string",
    "rights": [
        "string"
    ],
    "short_code": "string",
    "show_alert_status": true,
    "walks": [],
    "weighting": "string"
}

GET /activitymaps/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Aktivitätsdiagramm.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "description": "string",
    "id": 0,
    "mod_time": 0,
    "mode": "string",
    "name": "string",
    "owner": "string",
    "rights": [
        "string"
    ],
    "short_code": "string",
    "show_alert_status": true,
    "walks": [],
    "weighting": "string"
}

POST /activitymaps/{id}/query

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Aktivitätsdiagramm.

body: Objekt

Die Eigenschaften der Topologieabfrage.

from: Zahl

Der Anfangszeitstempel des Zeitbereichs, den die Abfrage durchsucht, ausgedrückt in Millisekunden seit der Epoche.

until: Zahl

(Optional) Der letzte Zeitstempel des Zeitbereichs, den die Abfrage durchsucht, ausgedrückt in Millisekunden seit der Epoche. Wenn kein Wert gesetzt ist, wird das Abfrageende standardmäßig auf „now" gesetzt.

edge_annotations: Reihe von Zeichenketten

(Optional) Die Liste mit einer oder mehreren Kantenanmerkungen, die in die Topologieabfrage aufgenommen werden sollen.

Die folgenden Werte sind gültig:

• protocols
• appearances

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "edge_annotations": [],
    "from": 0,
    "until": 0
}

Kopieren

DELETE /activitymaps/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Aktivitätsdiagramm.

PATCH /activitymaps/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Aktivitätsdiagramm.

body: Objekt

Die Eigenschaften der Aktivitätsdiagramm, die aktualisiert werden sollen.

GET /activitymaps/{id}/sharing

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Aktivitätsdiagramm.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "anyone": "string",
    "groups": {},
    "users": {}
}

PUT /activitymaps/{id}/sharing

Geben Sie die folgenden Parameter an.

body: Objekt

Die Benutzer und ihre Berechtigungsstufen.

id: Zahl

Die eindeutige Kennung für die Aktivitätsdiagramm.

PATCH /activitymaps/{id}/sharing

Geben Sie die folgenden Parameter an.

body: Objekt

Die Benutzer und ihre Berechtigungsstufen.

id: Zahl

Die eindeutige Kennung für die Aktivitätsdiagramm.

GET /alerts

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "apply_all": true,
    "author": "string",
    "categories": [
        "string"
    ],
    "cc": [],
    "description": "string",
    "disabled": true,
    "field_name": "string",
    "field_name2": "string",
    "field_op": "string",
    "id": 0,
    "interval_length": 0,
    "mod_time": 0,
    "name": "string",
    "notify_snmp": true,
    "object_type": "string",
    "operand": "string",
    "operator": "string",
    "param": {},
    "param2": {},
    "protocols": [
        "string"
    ],
    "refire_interval": 0,
    "severity": 0,
    "stat_name": "string",
    "type": "string",
    "units": "string"
}

POST /alerts

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftswerte auf die neue Alarm an.

description: Schnur

Eine optionale Beschreibung für die Alarm.

notify_snmp: Boolescher Wert

(Optional) Gibt an, ob ein SNMP-Trap gesendet werden soll, wenn eine Alarm generiert wird.

field_op: Schnur

Die Art des Vergleichs zwischen den Feldern field_name und field_name2 bei der Anwendung eines Verhältnisses. Gilt nur für Schwellenwertwarnungen.

Die folgenden Werte sind gültig:

• /
• null

stat_name: Schnur

Der Statistikname für die Alarm. Gilt nur für Schwellenwertwarnungen.

disabled: Boolescher Wert

(Optional) Gibt an, ob die Alarm deaktiviert ist.

operator: Schnur

Der logische Operator, der angewendet wird, wenn der Wert des Operandenfeldes mit Alarmbedingungen verglichen wird. Gilt nur für Schwellenwertwarnungen.

Die folgenden Werte sind gültig:

• ==
• >
• <
• >=
• <=

operand: Schnur

Der Wert, der mit den Alarmbedingungen verglichen werden soll. Die Vergleichsmethode wird durch den Wert des Operatorfeldes angegeben. Gilt nur für Schwellenwertwarnungen.

field_name: Schnur

Der Name der überwachten Metrik. Gilt nur für Schwellenwertwarnungen.

name: Schnur

Der eindeutige, freundliche Name für die Alarm.

cc: Reihe von Zeichenketten

Die Liste der E-Mail-Adressen, die nicht in einer E-Mail-Gruppe enthalten sind, um Benachrichtigungen zu erhalten.

apply_all: Boolescher Wert

Gibt an, ob die Alarm allen verfügbaren Datenquellen zugewiesen ist.

severity: Zahl

(Optional) Der Schweregrad der Alarm, der im Warnungsverlauf, in E-Mail-Benachrichtigungen und SNMP-Traps angezeigt wird. Schweregrade 0-2 erfordern sofortige Aufmerksamkeit. Die Schweregrade sind beschrieben in der REST-API-Leitfaden.

author: Schnur

Der Name des Benutzers, der die Alarm erstellt hat.

param: Objekt

Der erste Warnungsparameter, der entweder ein Schlüsselmuster oder ein Datenpunkt ist. Gilt nur für Schwellenwertwarnungen.

interval_length: Zahl

Die Länge des Warnintervalls, ausgedrückt in Sekunden. Gilt nur für Schwellenwertwarnungen.

Die folgenden Werte sind gültig:

• 30
• 60
• 120
• 300
• 600
• 900
• 1200
• 1800

param2: Objekt

Der zweite Warnungsparameter, der entweder ein Schlüsselmuster oder ein Datenpunkt ist. Gilt nur für Schwellenwertwarnungen.

units: Schnur

Das Intervall, in dem der Warnzustand ausgewertet werden soll. Gilt nur für Schwellenwertwarnungen.

Die folgenden Werte sind gültig:

• none
• period
• 1 sec
• 1 min
• 1 hr

field_name2: Schnur

Die zweite überwachte Metrik bei der Anwendung eines Verhältnisses. Gilt nur für Schwellenwertwarnungen.

refire_interval: Zahl

(Optional) Das Zeitintervall, in dem Warnbedingungen überwacht werden, ausgedrückt in Sekunden.

Die folgenden Werte sind gültig:

• 300
• 600
• 900
• 1800
• 3600
• 7200
• 14400

type: Schnur

Die Art der Alarm.

Die folgenden Werte sind gültig:

• threshold

object_type: Schnur

Der Typ der Metrikquelle, die von der Warnungskonfiguration überwacht wird. Gilt nur für Erkennungswarnungen.

Die folgenden Werte sind gültig:

• application
• device

protocols: Reihe von Zeichenketten

(Optional) Die Liste der überwachten Protokolle. Gilt nur für Erkennungswarnungen.

categories: Reihe von Zeichenketten

(Optional) Die Liste mit einer oder mehreren Erkennungskategorien. Eine Alarm wird nur generiert, wenn eine Erkennung in den angegebenen Kategorien identifiziert wird. Gilt nur für Erkennungswarnungen.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "apply_all": true,
    "author": "string",
    "categories": [
        "string"
    ],
    "cc": [],
    "description": "string",
    "disabled": true,
    "field_name": "string",
    "field_name2": "string",
    "field_op": "string",
    "interval_length": 0,
    "name": "string",
    "notify_snmp": true,
    "object_type": "string",
    "operand": "string",
    "operator": "string",
    "param": {},
    "param2": {},
    "protocols": [
        "string"
    ],
    "refire_interval": 0,
    "severity": 0,
    "stat_name": "string",
    "type": "string",
    "units": "string"
}

Kopieren

GET /alerts/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Alarm.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "apply_all": true,
    "author": "string",
    "categories": [
        "string"
    ],
    "cc": [],
    "description": "string",
    "disabled": true,
    "field_name": "string",
    "field_name2": "string",
    "field_op": "string",
    "id": 0,
    "interval_length": 0,
    "mod_time": 0,
    "name": "string",
    "notify_snmp": true,
    "object_type": "string",
    "operand": "string",
    "operator": "string",
    "param": {},
    "param2": {},
    "protocols": [
        "string"
    ],
    "refire_interval": 0,
    "severity": 0,
    "stat_name": "string",
    "type": "string",
    "units": "string"
}

DELETE /alerts/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Alarm.

PATCH /alerts/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftswertaktualisierungen auf die Alarm an.

id: Zahl

Die eindeutige Kennung für die Alarm.

GET /alerts/{id}/stats

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Alarm.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "alert_id": 0,
    "field_name": "string",
    "id": 0,
    "param": "string",
    "stat_name": "string"
}

GET /alerts/{id}/devicegroups

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/devicegroups

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für Gerätegruppen, die der Alarm zugewiesen und nicht zugewiesen ist.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/devicegroups/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

id: Zahl

Die eindeutige Kennung für die Alarm.

DELETE /alerts/{id}/devicegroups/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

id: Zahl

Die eindeutige Kennung für die Alarm.

GET /alerts/{id}/emailgroups

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/emailgroups

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für E-Mail-Gruppen, die der Alarm zugewiesen und nicht zugewiesen ist.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/emailgroups/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die E-Mail-Gruppe.

id: Zahl

Die eindeutige Kennung für die Alarm.

DELETE /alerts/{id}/emailgroups/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die E-Mail-Gruppe.

id: Zahl

Die eindeutige Kennung für die Alarm.

GET /alerts/{id}/exclusionintervals

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/exclusionintervals

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für Ausschlussintervalle, die der Alarm zugewiesen und nicht zugewiesen ist.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/exclusionintervals/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Ausschlussintervall.

id: Zahl

Die eindeutige Kennung für die Alarm.

DELETE /alerts/{id}/exclusionintervals/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Ausschlussintervall.

id: Zahl

Die eindeutige Kennung für die Alarm.

GET /alerts/{id}/devices

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/devices

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für Geräte, die der Alarm zugewiesen und nicht zugewiesen sind.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/devices/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Gerät.

id: Zahl

Die eindeutige Kennung für die Alarm.

DELETE /alerts/{id}/devices/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Gerät.

id: Zahl

Die eindeutige Kennung für die Alarm.

GET /alerts/{id}/networks

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/networks

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für Netzwerke, die der Alarm zugewiesen und nicht zugewiesen ist.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/networks/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Netzwerk.

id: Zahl

Die eindeutige Kennung für die Alarm.

DELETE /alerts/{id}/networks/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Netzwerk.

id: Zahl

Die eindeutige Kennung für die Alarm.

GET /alerts/{id}/applications

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/applications

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für Anwendungen, die der Alarm zugewiesen und nicht zugewiesen sind.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Alarm.

POST /alerts/{id}/applications/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Anwendung.

id: Zahl

Die eindeutige Kennung für die Alarm.

DELETE /alerts/{id}/applications/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Anwendung.

id: Zahl

Die eindeutige Kennung für die Alarm.

GET /analysispriority/{appliance_id}/manager

Geben Sie die folgenden Parameter an.

appliance_id: Zahl

Die Kennung für den lokalen Sensor. Dieser Wert muss auf 0 gesetzt werden.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "manager": {}
}

GET /analysispriority/config/{appliance_id}

Geben Sie die folgenden Parameter an.

appliance_id: Zahl

Die Kennung für einen Sensor. Setzen Sie diesen Wert auf 0, wenn Sie einen Sensor aufrufen.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "advanced_rules": [],
    "autofill_advanced": true,
    "autofill_standard": true,
    "is_in_effect": true,
    "standard_rules": []
}

PUT /analysispriority/config/{appliance_id}

Geben Sie die folgenden Parameter an.

body: Objekt

Die Eigenschaften der Regeln für die Prioritätsanalyse.

autofill_advanced: Boolescher Wert

Gibt an, ob Geräte automatisch in Erweiterte Analyse platziert werden sollen, bis die Kapazität erreicht ist. Geräte in der Liste advanced_rules werden priorisiert, gefolgt von Geräten in der Liste standard_rules und dann nach der Erkennungszeit für das Gerät. Die Kapazität für Erweiterte Analyse wird durch die ExtraHop-Systemlizenz bestimmt.

advanced_rules: Reihe von Objekten

(Optional) Die Erweiterte Analyse Analysis-Prioritätsregeln für eine Gerätegruppe.

type: Schnur

Der Gruppentyp, für den die Prioritätsregeln für die Analyse gelten.

Die folgenden Werte sind gültig:

• device_group

object_id: Zahl

Die eindeutige Kennung für die Gruppe.

description: Schnur

(Optional) Die Beschreibung der Prioritätsregeln für Analysen.

autofill_standard: Boolescher Wert

Gibt an, ob Geräte automatisch in die Standardanalyse aufgenommen werden sollen, bis die Gesamtkapazität erreicht ist. Geräte in der Liste standard_rules werden priorisiert, gefolgt von der Erkennungszeit für das Gerät. Die Gesamtkapazität wird durch die ExtraHop-Systemlizenz bestimmt.

standard_rules: Reihe von Objekten

(Optional) Die Standardanalyse-Prioritätsregeln für eine Gerätegruppe.

type: Schnur

Der Gruppentyp, für den die Prioritätsregeln für die Analyse gelten.

Die folgenden Werte sind gültig:

• device_group

object_id: Zahl

Die eindeutige Kennung für die Gruppe.

description: Schnur

(Optional) Die Beschreibung der Prioritätsregeln für Analysen.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "advanced_rules": {
        "type": "string",
        "object_id": 0,
        "description": "string"
    },
    "autofill_advanced": true,
    "autofill_standard": true,
    "standard_rules": {
        "type": "string",
        "object_id": 0,
        "description": "string"
    }
}

Kopieren

appliance_id: Zahl

Die Kennung für einen Sensor. Setzen Sie diesen Wert auf 0, wenn Sie einen Sensor aufrufen.

PATCH /analysispriority/{appliance_id}/manager

Geben Sie die folgenden Parameter an.

body: Objekt

Die ID des Sensor oder der Konsole, die die Prioritätsregeln für die Analyse des lokalen Sensor verwaltet. Setzen Sie diesen Wert auf 0, um die Verwaltung des lokalen Sensor wiederherzustellen.

manager: Zahl

Die eindeutige Kennung für den verwaltenden Sensor oder die verwaltende Konsole.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "manager": 0
}

Kopieren

appliance_id: Zahl

Die Kennung für den lokalen Sensor. Dieser Wert muss auf 0 gesetzt werden.

GET /appliances

Für diesen Vorgang gibt es keine Parameter.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "add_time": 0,
    "advanced_analysis_capacity": 0,
    "analysis_levels_managed": true,
    "connection_type": "string",
    "data_access": true,
    "display_name": "string",
    "fingerprint": "string",
    "firmware_version": "string",
    "hostname": "string",
    "id": 0,
    "license_platform": "string",
    "license_status": "string",
    "licensed_features": {},
    "licensed_modules": [
        "string"
    ],
    "managed_by_local": true,
    "manages_local": true,
    "nickname": "string",
    "platform": "string",
    "status_message": "string",
    "sync_time": 0,
    "total_capacity": 0,
    "uuid": "string"
}

GET /appliances/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Geben Sie die eindeutige Kennung für die Remote-Appliance an.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "add_time": 0,
    "advanced_analysis_capacity": 0,
    "analysis_levels_managed": true,
    "connection_type": "string",
    "data_access": true,
    "display_name": "string",
    "fingerprint": "string",
    "firmware_version": "string",
    "hostname": "string",
    "id": 0,
    "license_platform": "string",
    "license_status": "string",
    "licensed_features": {},
    "licensed_modules": [
        "string"
    ],
    "managed_by_local": true,
    "manages_local": true,
    "nickname": "string",
    "platform": "string",
    "status_message": "string",
    "sync_time": 0,
    "total_capacity": 0,
    "uuid": "string"
}

GET /appliances/{ids_id}/association

Geben Sie die folgenden Parameter an.

ids_id: Zahl

Geben Sie die ID des IDS-Sensors an.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "associated_sensor_id": 0
}

POST /appliances/{ids_id}/association

Geben Sie die folgenden Parameter an.

ids_id: Zahl

Geben Sie die ID des IDS-Sensors an.

body: Objekt

Geben Sie die ID des Paketsensor an.

associated_sensor_id: Zahl

Die ID des Paketsensor.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "associated_sensor_id": 0
}

Kopieren

GET /appliances/firmware/next

Geben Sie die folgenden Parameter an.

ids: Schnur

(Optional) Eine CSV-Liste mit eindeutigen Kennungen für die Remote-Appliances. Wenn dieser Parameter angegeben ist, gibt der Vorgang Firmware-Versionen zurück, auf die alle angegebenen Remote-Appliances aktualisiert werden können. Wenn dieser Parameter nicht angegeben ist, gibt der Vorgang Firmware-Versionen zurück, auf die jedes Remote-Gerät aktualisiert werden kann.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "release": "string",
    "versions": []
}

POST /appliances/firmware/upgrade

Geben Sie die folgenden Parameter an.

body: Objekt

Die Firmware-Upgrade-Optionen.

version: Schnur

Die Firmware-Version, auf die Geräte aktualisiert werden sollen. Sie können eine Liste der gültigen Versionen mit dem Vorgang GET /api/v1/appliances/firmware/next abrufen.

system_ids: Reihe von Zahlen

Eine Liste mit eindeutigen Kennungen für die Remote-Appliances. Sie können Appliance-IDs mit dem Vorgang GET /api/v1/appliances abrufen. Appliance-IDs werden in den ID-Feldern der Antwort zurückgegeben.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "system_ids": [],
    "version": "string"
}

Kopieren

GET /applications/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Anwendung.

include_criteria: Boolescher Wert

(Optional) Gibt an, ob die mit der Anwendung verknüpften Kriterien in die Antwort aufgenommen werden sollen.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "criteria": [],
    "description": "string",
    "discovery_id": "string",
    "display_name": "string",
    "extrahop_id": "string",
    "id": 0,
    "mod_time": 0,
    "node_id": 0,
    "user_mod_time": 0
}

POST /applications

Geben Sie die folgenden Parameter an.

body: Objekt

Die Eigenschaften der Anwendung.

node_id: Zahl

(Optional) Die eindeutige Kennung für den Sensor, dem diese Anwendung zugeordnet ist. Der Bezeichner kann über den Vorgang GET /appliances abgerufen werden. Dieses Feld ist nur auf einer Konsole gültig.

discovery_id: Schnur

Die eindeutige Kennung für die Anwendung, die auf der Anwendungsseite im ExtraHop-System angezeigt wird.

display_name: Schnur

Der benutzerfreundliche Name für die Anwendung.

description: Schnur

(Optional) Eine optionale Beschreibung der Anwendung.

criteria: Reihe von Objekten

(Optional) Eine Reihe von Protokoll- und Quellkriterien, die mit der Anwendung verknüpft sind. Der Inhalt dieses Arrays wird im Abschnitt „Kriterien" unten definiert.

protocol_default: Schnur

Die von der Anwendung überwachten Standardprotokolle. Unterstützte Werte sind „any" und „none".

sources: Reihe von Objekten

Ein Array, das eine oder mehrere der Anwendung zugeordnete Metrik Quellen enthält. Die Anwendung sammelt nur Metriken aus den angegebenen Quellen. Der Inhalt dieses Arrays ist im Abschnitt „Quelle" unten definiert.

type: Schnur

Der Typ der Metrikquelle, die der Anwendung zugeordnet ist. Unterstützte Quelltypwerte sind 'Gerät' und 'device_group'.

id: Zahl

Die eindeutige Kennung für das Gerät oder die Gerätegruppe, die der Anwendung zugeordnet ist.

protocols: Objekt

(Optional) Die Liste mit einer oder mehreren Protokoll- und Rollenzuordnungen, die der Anwendung zugeordnet sind. Die Anwendung sammelt nur Metriken aus den angegebenen Protokollen. Das Format jedes Protokoll ist {'Protokoll': 'role'}. Beispiel: {'http': 'server'}. Unterstützte Rollenwerte sind „Client", „Server", „any" oder „none".

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "criteria": {
        "protocol_default": "string",
        "sources": {
            "type": "string",
            "id": 0
        },
        "protocols": {}
    },
    "description": "string",
    "discovery_id": "string",
    "display_name": "string",
    "node_id": 0
}

Kopieren

PATCH /applications/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftenupdates auf die Anwendung an.

id: Zahl

Die eindeutige Kennung für die Anwendung.

GET /applications

Geben Sie die folgenden Parameter an.

active_from: Zahl

(Optional) Gibt nur Anwendungen zurück, die nach der angegebenen Zeit aktiv sind. Positive Werte geben die Zeit in Millisekunden seit der Epoche an. Negative Werte geben die Zeit in Millisekunden vor der aktuellen Uhrzeit an.

active_until: Zahl

(Optional) Gibt nur Anwendungen zurück, die vor dem angegebenen Zeitpunkt aktiv waren. Positive Werte geben die Zeit in Millisekunden seit der Epoche an. Negative Werte geben die Zeit in Millisekunden vor der aktuellen Uhrzeit an.

limit: Zahl

(Optional) Beschränken Sie die Anzahl der Anwendungen, die zurückgegeben werden, auf die angegebene Höchstzahl.

offset: Zahl

(Optional) Überspringen Sie die ersten n Anwendungsergebnisse. Dieser Parameter wird häufig mit dem Grenzparameter kombiniert.

search_type: Schnur

Der Objekttyp, nach dem gesucht werden soll.

Die folgenden Werte sind gültig:

• any
• name
• node
• discovery_id
• extrahop-id

value: Schnur

(Optional) Die Suchkriterien. Fügen Sie vor und nach den Kriterien einen Schrägstrich hinzu, um den RegEx-Abgleich anzuwenden.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "criteria": [],
    "description": "string",
    "discovery_id": "string",
    "display_name": "string",
    "extrahop_id": "string",
    "id": 0,
    "mod_time": 0,
    "node_id": 0,
    "user_mod_time": 0
}

GET /applications/{id}/activity

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Anwendung.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "application_id": 0,
    "from_time": 0,
    "id": 0,
    "mod_time": 0,
    "stat_name": "string",
    "until_time": 0
}

GET /applications/{id}/alerts

Geben Sie die folgenden Parameter an.

id: Zahl

Rufen Sie den eindeutigen Bezeichner für die Anwendung ab.

direct_assignments_only: Boolescher Wert

(Optional) Gibt an, ob die Ergebnisse auf Warnungen beschränkt sind, die der Anwendung direkt zugewiesen sind.

POST /applications/{id}/alerts

Geben Sie die folgenden Parameter an.

body: Objekt

Weist die angegebene Liste eindeutiger Kennungen für Warnmeldungen zu oder hebt deren Zuweisung auf.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Geben Sie eine eindeutige Kennung für die Anwendung ein.

POST /applications/{id}/alerts/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Alarm.

id: Zahl

Die eindeutige Kennung für die Anwendung.

DELETE /applications/{id}/alerts/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Alarm.

id: Zahl

Die eindeutige Kennung für die Anwendung.

GET /applications/{id}/dashboards

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Anwendung.

GET /auditlog

Geben Sie die folgenden Parameter an.

limit: Zahl

(Optional) Die maximale Anzahl von Protokollnachrichten, die zurückgegeben werden sollen.

offset: Zahl

(Optional) Die Anzahl der Protokollnachrichten, die in den Ergebnissen übersprungen werden sollen. Gibt Logmeldungen ab dem Offset-Wert zurück.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "body": {},
    "id": 0,
    "occur_time": 0,
    "time": 0
}

GET /bundles

Für diesen Vorgang gibt es keine Parameter.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "built_in": true,
    "created_time": 0,
    "description": "string",
    "id": 0,
    "mod_time": 0,
    "name": "string"
}

POST /bundles

Geben Sie die folgenden Parameter an.

body: Schnur

Ein JSON-formatierter Bundle-Export.

name: Schnur

Der freundliche Name für das Paket.

description: Schnur

(Optional) Eine optionale Beschreibung für das Paket.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "description": "string",
    "name": "string"
}

Kopieren

GET /bundles/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Paket.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "built_in": true,
    "created_time": 0,
    "description": "string",
    "id": 0,
    "mod_time": 0,
    "name": "string"
}

DELETE /bundles/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Paket.

POST /bundles/{id}/apply

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Paket.

body: Objekt

Die Konfigurationsoptionen für die Anwendung des Paket.

policy: Schnur

Gibt an, ob widersprüchliche Objekte überschrieben oder übersprungen werden sollen.

Die folgenden Werte sind gültig:

• overwrite
• skip

include_assignments: Boolescher Wert

Gibt an, ob Objektzuweisungen mit dem Paket wiederhergestellt werden sollen.

node_ids: Reihe von Zahlen

Eine Liste mit eindeutigen Kennungen für die Sensoren, auf die das Paket angewendet werden soll. Dieses Feld ist nur auf einer Konsole gültig.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "include_assignments": true,
    "node_ids": [],
    "policy": "string"
}

Kopieren

GET /dashboards

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "author": "string",
    "comment": "string",
    "id": 0,
    "mod_time": 0,
    "name": "string",
    "owner": "string",
    "rights": [
        "string"
    ],
    "short_code": "string",
    "type": "string"
}

GET /dashboards/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Dashboard.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "author": "string",
    "comment": "string",
    "id": 0,
    "mod_time": 0,
    "name": "string",
    "owner": "string",
    "rights": [
        "string"
    ],
    "short_code": "string",
    "type": "string"
}

DELETE /dashboards/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Dashboard.

PATCH /dashboards/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Der Benutzername des Dashboard-Besitzers.

id: Zahl

Die eindeutige Kennung für das Dashboard.

GET /dashboards/{id}/sharing

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Dashboard.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "anyone": "string",
    "groups": {},
    "users": {}
}

PUT /dashboards/{id}/sharing

Geben Sie die folgenden Parameter an.

body: Objekt

Die Benutzer und ihre Berechtigungsstufen.

id: Zahl

Die eindeutige Kennung für das Dashboard.

PATCH /dashboards/{id}/sharing

Geben Sie die folgenden Parameter an.

body: Objekt

Die Benutzer und ihre Berechtigungsstufen.

id: Zahl

Die eindeutige Kennung für das Dashboard.

GET /dashboards/{id}/reports

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Dashboard.

GET /devicegroups

Geben Sie die folgenden Parameter an.

since: Zahl

(Optional) Gibt nur Gerätegruppen zurück, die nach dieser Zeit geändert wurden, ausgedrückt in Millisekunden seit der Epoche.

all: Boolescher Wert

(Optional) Veraltet. Ersetzt durch den Typparameter.

name: Schnur

(Optional) Der Regex-Suchwert zum Filtern der Gerätegruppen nach Namen.

type: Schnur

(Optional) Gibt nur Gerätegruppen des angegebenen Typs zurück.

Die folgenden Werte sind gültig:

• user_created
• built_in
• all

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "built_in": true,
    "description": "string",
    "dynamic": true,
    "editors": [],
    "field": "string",
    "filter": {},
    "id": 0,
    "include_custom_devices": true,
    "mod_time": 0,
    "name": "string",
    "value": "string"
}

GET /devicegroups/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "built_in": true,
    "description": "string",
    "dynamic": true,
    "editors": [],
    "field": "string",
    "filter": {},
    "id": 0,
    "include_custom_devices": true,
    "mod_time": 0,
    "name": "string",
    "value": "string"
}

POST /devicegroups

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftswerte auf die neue Gerätegruppe an.

description: Schnur

Eine optionale Beschreibung der Gerätegruppe.

name: Schnur

Der benutzerfreundliche Name für die Gerätegruppe.

include_custom_devices: Boolescher Wert

(Optional) Veraltet. Ersetzt durch den Filterparameter.

dynamic: Boolescher Wert

(Optional) Gibt an, ob die Gerätegruppe dynamisch ist.

field: Schnur

Veraltet. Ersetzt durch den Filterparameter.

Die folgenden Werte sind gültig:

• any
• name
• ip address
• mac address
• vendor
• type
• tag
• vlan
• activity
• node
• discover time

value: Objekt

(Optional) Veraltet. Ersetzt durch den Filterparameter.

filter: Objekt

(Optional) Geben Sie die Filterkriterien für Suchergebnisse an.

field: Schnur

Der Name des Feld, nach dem Ergebnisse gefiltert werden sollen. Bei der Suche wird der Inhalt des Feldparameters mit dem Wert des Operandenparameters verglichen.

Die folgenden Werte sind gültig:

• name
• ipaddr
• macaddr
• vendor
• tag
• activity
• node
• vlan
• discover_time
• role
• dns_name
• dhcp_name
• netbios_name
• cdp_name
• custom_name
• software
• model
• is_critical
• instance_id
• instance_name
• instance_type
• cloud_account
• vpc_id
• subnet_id
• is_active
• network_locality_type
• network_locality_id
• id

operator: Schnur

Die Vergleichsmethode, die angewendet wird, wenn der Operandenwert mit dem Feldinhalt verglichen wird. Alle Filterobjekte benötigen einen Operator.

Die folgenden Werte sind gültig:

• >
• <
• <=
• >=
• =
• !=
• startswith
• and
• or
• not
• exists
• not_exists
• ~
• !~

operand: Zeichenfolge oder Zahl oder Objekt

Der Wert, mit dem die Abfrage zu vergleichen versucht. Die Abfrage vergleicht den Wert des Operanden mit dem Inhalt des Feldparameters und wendet die durch den Operatorparameter angegebene Vergleichsmethode an. Sie können den Operanden als Zeichenfolge, Ganzzahl oder Objekt angeben. Informationen zu Objektwerten finden Sie in der REST-API-Leitfaden.

rules: Reihe von Objekten

Ein Array von einem oder mehreren Filterobjekten, die rekursiv eingebettet werden können. Für diesen Parameter sind nur die Operatoren „und", „Oder" und „Nicht" zulässig.

editors: Reihe von Zeichenketten

(Optional) Die Liste der Benutzer, die die Gerätegruppe bearbeiten können.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "description": "string",
    "dynamic": true,
    "editors": [],
    "field": "string",
    "filter": {
        "field": "string",
        "operator": "string",
        "operand": "string",
        "rules": []
    },
    "include_custom_devices": true,
    "name": "string",
    "value": "string"
}

Kopieren

DELETE /devicegroups/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

PATCH /devicegroups/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Wenden Sie die angegebenen Eigenschaftswertaktualisierungen auf eine bestimmte Gerätegruppe an.

description: Schnur

Eine optionale Beschreibung der Gerätegruppe.

name: Schnur

Der benutzerfreundliche Name für die Gerätegruppe.

include_custom_devices: Boolescher Wert

(Optional) Veraltet. Ersetzt durch den Filterparameter.

field: Schnur

Veraltet. Ersetzt durch den Filterparameter.

Die folgenden Werte sind gültig:

• any
• name
• ip address
• mac address
• vendor
• type
• tag
• vlan
• activity
• node
• discover time

value: Objekt

(Optional) Veraltet. Ersetzt durch den Filterparameter.

filter: Objekt

(Optional) Geben Sie die Filterkriterien für Suchergebnisse an.

editors: Reihe von Zeichenketten

(Optional) Die Liste der Benutzer, die die Gerätegruppe bearbeiten können.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "description": "string",
    "editors": [],
    "field": "string",
    "filter": {},
    "include_custom_devices": true,
    "name": "string",
    "value": "string"
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

GET /devicegroups/{id}/alerts

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

direct_assignments_only: Boolescher Wert

(Optional) Beschränken Sie die Ergebnisse auf Warnmeldungen, die der Gerätegruppe direkt zugewiesen sind.

POST /devicegroups/{id}/alerts/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Alarm.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

DELETE /devicegroups/{id}/alerts/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Alarm.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

POST /devicegroups/{id}/alerts

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für Warnmeldungen, die der Gerätegruppe zugewiesen und nicht zugewiesen ist.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

GET /devicegroups/{id}/triggers

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

direct_assignments_only: Boolescher Wert

(Optional) Beschränken Sie die Ergebnisse auf Auslöser, die der Gerätegruppe direkt zugewiesen sind.

POST /devicegroups/{id}/triggers/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für den Auslöser.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

DELETE /devicegroups/{id}/triggers/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für den Auslöser.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

POST /devicegroups/{id}/triggers

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Identifikatoren für Auslöser, die der Gerätegruppe zugewiesen und nicht zugewiesen ist.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

POST /devicegroups/{id}/devices/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für ein Gerät.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

DELETE /devicegroups/{id}/devices/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für ein Gerät.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

POST /devicegroups/{id}/devices

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für Geräte, die der Gerätegruppe zugewiesen und nicht zugewiesen ist.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

GET /devicegroups/{id}/devices

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

active_from: Zahl

(Optional) Der Anfangszeitstempel für die Anfrage. Gibt nur Geräte zurück, die nach dieser Zeit aktiv sind. Die Zeit seit der Epoche wird in Millisekunden ausgedrückt. 0 gibt die Uhrzeit der Anfrage an. Ein negativer Wert wird relativ zur aktuellen Zeit ausgewertet. Die Standardeinheit für einen negativen Wert ist Millisekunden, aber andere Einheiten können mit einem Einheitensuffix angegeben werden. Sehen Sie die REST-API-Leitfaden für unterstützte Zeiteinheiten und Suffixe.

active_until: Zahl

(Optional) Der Endzeitstempel für die Anfrage. Gibt nur das Gerät zurück, das vor diesem Zeitpunkt aktiv war. Folgt den gleichen Zeitwertrichtlinien wie der Parameter active_from.

limit: Zahl

(Optional) Beschränken Sie die Anzahl der zurückgegebenen Geräte.

offset: Zahl

(Optional) Überspringen Sie die ersten n Geräteergebnisse. Dieser Parameter wird häufig mit dem Grenzparameter kombiniert.

GET /devicegroups/{id}/dashboards

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

GET /devices

Geben Sie die folgenden Parameter an.

active_from: Zahl

(Optional) Der Anfangszeitstempel für die Anfrage. Gibt nur Geräte zurück, die nach dieser Zeit aktiv sind. Die Zeit seit der Epoche wird in Millisekunden ausgedrückt. 0 gibt die Uhrzeit der Anfrage an. Ein negativer Wert wird relativ zur aktuellen Zeit ausgewertet. Die Standardeinheit für einen negativen Wert ist Millisekunden, aber andere Einheiten können mit einem Einheitensuffix angegeben werden. Sehen Sie die REST-API-Leitfaden für unterstützte Zeiteinheiten und Suffixe.

active_until: Zahl

(Optional) Der Endzeitstempel für die Anfrage. Gibt nur das Gerät zurück, das vor diesem Zeitpunkt aktiv war. Folgt den gleichen Zeitwertrichtlinien wie der Parameter active_from.

limit: Zahl

(Optional) Beschränken Sie die Anzahl der zurückgegebenen Geräte auf die angegebene Höchstzahl.

offset: Zahl

(Optional) Überspringen Sie die ersten n Geräteergebnisse. Dieser Parameter wird häufig mit dem Grenzparameter kombiniert.

search_type: Schnur

Zeigt das zu durchsuchende Feld an.

Die folgenden Werte sind gültig:

• any
• name
• discovery_id
• ip address
• mac address
• vendor
• type
• tag
• activity
• node
• vlan
• discover time

value: Schnur

(Optional) Gibt die Suchkriterien an.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "activity": [],
    "analysis": "string",
    "analysis_level": 0,
    "auto_role": "string",
    "cdp_name": "string",
    "cloud_account": "string",
    "cloud_instance_description": "string",
    "cloud_instance_id": "string",
    "cloud_instance_name": "string",
    "cloud_instance_type": "string",
    "critical": true,
    "custom_criticality": "string",
    "custom_make": "string",
    "custom_model": "string",
    "custom_name": "string",
    "custom_type": "string",
    "default_name": "string",
    "description": "string",
    "device_class": "string",
    "dhcp_name": "string",
    "discover_time": 0,
    "discovery_id": "string",
    "display_name": "string",
    "dns_name": "string",
    "extrahop_id": "string",
    "id": 0,
    "ipaddr4": "string",
    "ipaddr6": "string",
    "is_l3": true,
    "last_seen_time": 0,
    "macaddr": "string",
    "mod_time": 0,
    "model": "string",
    "model_override": "string",
    "netbios_name": "string",
    "node_id": 0,
    "on_watchlist": true,
    "parent_id": 0,
    "role": "string",
    "subnet_id": "string",
    "user_mod_time": 0,
    "vendor": "string",
    "vlanid": 0,
    "vpc_id": "string"
}

POST /devices/search

Geben Sie die folgenden Parameter an.

body: Objekt

Die Gerätekriterien.

active_from: Zahl

(Optional) Der Anfangszeitstempel für die Anfrage. Gibt nur Geräte zurück, die nach dieser Zeit aktiv sind. Die Zeit seit der Epoche wird in Millisekunden ausgedrückt. 0 gibt die Uhrzeit der Anfrage an. Ein negativer Wert wird relativ zur aktuellen Zeit ausgewertet. Die Standardeinheit für einen negativen Wert ist Millisekunden, aber andere Einheiten können mit einem Einheitensuffix angegeben werden. Sehen Sie die REST-API-Leitfaden für unterstützte Zeiteinheiten und Suffixe.

active_until: Zahl

(Optional) Der Endzeitstempel für die Anfrage. Gibt nur Geräte zurück, die vor diesem Zeitpunkt aktiv waren. Folgt den gleichen Zeitwertrichtlinien wie der Parameter active_from.

limit: Zahl

(Optional) Beschränken Sie die Anzahl der zurückgegebenen Geräte auf die angegebene Höchstzahl.

offset: Zahl

(Optional) Überspringen Sie die angegebene Anzahl von Geräten. Dieser Parameter wird häufig mit dem Grenzparameter kombiniert, um Ergebnismengen zu paginieren.

filter: Objekt

(Optional) Geben Sie die Filterkriterien für Suchergebnisse an.

field: Schnur

Der Name des Feld, nach dem Ergebnisse gefiltert werden sollen. Bei der Suche wird der Inhalt des Feldparameters mit dem Wert des Operandenparameters verglichen.

Die folgenden Werte sind gültig:

• name
• discovery_id
• ipaddr
• macaddr
• vendor
• tag
• activity
• node
• vlan
• discover_time
• role
• dns_name
• dhcp_name
• netbios_name
• cdp_name
• custom_name
• software
• model
• is_critical
• instance_id
• instance_name
• instance_type
• cloud_account
• vpc_id
• subnet_id
• is_active
• analysis
• network_locality_type
• network_locality_id
• id

operator: Schnur

Die Vergleichsmethode, die angewendet wird, wenn der Operandenwert mit dem Feldinhalt verglichen wird. Alle Filterobjekte benötigen einen Operator.

Die folgenden Werte sind gültig:

• >
• <
• <=
• >=
• =
• !=
• startswith
• and
• or
• not
• exists
• not_exists
• ~
• !~
• in
• not_in

operand: Zeichenfolge oder Zahl oder Objekt oder Array

Der Wert, mit dem die Abfrage zu vergleichen versucht. Die Abfrage vergleicht den Wert des Operanden mit dem Inhalt des Feldparameters und wendet die durch den Operatorparameter angegebene Vergleichsmethode an. Sie können den Operanden als Zeichenfolge, Ganzzahl oder Objekt angeben. Informationen zu Objektwerten finden Sie in der REST-API-Leitfaden.

rules: Reihe von Objekten

Ein Array von einem oder mehreren Filterobjekten, die rekursiv eingebettet werden können. Für diesen Parameter sind nur die Operatoren „und", „Oder" und „Nicht" zulässig.

result_fields: Reihe von Zeichenketten

(Optional) Gibt die angegebenen Felder und die Geräte-ID zurück. Wenn diese Option nicht angegeben ist, werden alle Felder zurückgegeben.

Die folgenden Werte sind gültig:

• mod_time
• node_id
• id
• extrahop_id
• discovery_id
• display_name
• description
• user_mod_time
• discover_time
• vlanid
• parent_id
• macaddr
• vendor
• is_l3
• ipaddr4
• ipaddr6
• device_class
• default_name
• custom_name
• cdp_name
• dhcp_name
• netbios_name
• dns_name
• custom_type
• auto_role
• analysis_level
• analysis
• role
• on_watchlist
• last_seen_time
• activity
• model
• model_override
• custom_make
• custom_model
• critical
• custom_criticality
• cloud_instance_id
• cloud_instance_type
• cloud_instance_description
• cloud_instance_name
• cloud_account
• vpc_id
• subnet_id

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "active_from": 0,
    "active_until": 0,
    "filter": {
        "field": "string",
        "operator": "string",
        "operand": "string",
        "rules": []
    },
    "limit": 0,
    "offset": 0,
    "result_fields": []
}

Kopieren

GET /devices/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "activity": [],
    "analysis": "string",
    "analysis_level": 0,
    "auto_role": "string",
    "cdp_name": "string",
    "cloud_account": "string",
    "cloud_instance_description": "string",
    "cloud_instance_id": "string",
    "cloud_instance_name": "string",
    "cloud_instance_type": "string",
    "critical": true,
    "custom_criticality": "string",
    "custom_make": "string",
    "custom_model": "string",
    "custom_name": "string",
    "custom_type": "string",
    "default_name": "string",
    "description": "string",
    "device_class": "string",
    "dhcp_name": "string",
    "discover_time": 0,
    "discovery_id": "string",
    "display_name": "string",
    "dns_name": "string",
    "extrahop_id": "string",
    "id": 0,
    "ipaddr4": "string",
    "ipaddr6": "string",
    "is_l3": true,
    "last_seen_time": 0,
    "macaddr": "string",
    "mod_time": 0,
    "model": "string",
    "model_override": "string",
    "netbios_name": "string",
    "node_id": 0,
    "on_watchlist": true,
    "parent_id": 0,
    "role": "string",
    "subnet_id": "string",
    "user_mod_time": 0,
    "vendor": "string",
    "vlanid": 0,
    "vpc_id": "string"
}

PATCH /devices/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftswertaktualisierungen auf das Gerät an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

GET /devices/{id}/activity

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "device_id": 0,
    "from_time": 0,
    "id": 0,
    "mod_time": 0,
    "stat_name": "string",
    "until_time": 0
}

GET /devices/{id}/ipaddrs

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

from: Zahl

(Optional) Ruft IP-Adressen ab, die dem Gerät nach dem angegebenen Datum zugeordnet wurden, ausgedrückt in Millisekunden seit der Epoche.

until: Zahl

(Optional) Ruft IP-Adressen ab, die dem Gerät vor dem angegebenen Datum zugeordnet waren, ausgedrückt in Millisekunden seit der Epoche.

GET /devices/{id}/dnsnames

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

from: Zahl

(Optional) Ruft DNS-Namen ab, die dem Gerät nach dem angegebenen Datum zugeordnet wurden, ausgedrückt in Millisekunden seit der Epoche.

until: Zahl

(Optional) Ruft DNS-Namen ab, die dem Gerät vor dem angegebenen Datum zugeordnet waren, ausgedrückt in Millisekunden seit der Epoche.

GET /devices/{id}/triggers

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

direct_assignments_only: Boolescher Wert

(Optional) Beschränken Sie die Ergebnisse auf Auslöser, die dem Gerät direkt zugewiesen sind.

POST /devices/{id}/triggers

Geben Sie die folgenden Parameter an.

body: Objekt

Eine Liste mit eindeutigen Kennungen für Auslöser, die dem Gerät zugewiesen und nicht zugewiesen sind.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

POST /devices/{id}/triggers/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für den Auslöser.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

DELETE /devices/{id}/triggers/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für den Auslöser.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

GET /devices/{id}/dashboards

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

GET /devices/{id}/devicegroups

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät.

active_from: Zahl

(Optional) Der Anfangszeitstempel für die Anfrage. Gibt nur dynamische Gerätegruppen zurück, zu denen das Gerät nach dieser Zeit gehörte. Die Zeit seit der Epoche wird in Millisekunden ausgedrückt. 0 gibt die Uhrzeit der Anfrage an. Ein negativer Wert wird relativ zur aktuellen Zeit ausgewertet. Die Standardeinheit für einen negativen Wert ist Millisekunden, aber andere Einheiten können mit einem Einheitensuffix angegeben werden. Sehen Sie die REST-API-Leitfaden für unterstützte Zeiteinheiten und Suffixe.

active_until: Zahl

(Optional) Der Endzeitstempel für die Anfrage. Gibt nur dynamische Gerätegruppen zurück, zu denen das Gerät vor diesem Zeitpunkt gehörte. Folgt den gleichen Zeitwertrichtlinien wie der Parameter active_from.

POST /devices/{id}/devicegroups

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für Gerätegruppen, die dem Gerät zugewiesen und nicht zugewiesen sind.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

POST /devices/{id}/devicegroups/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

DELETE /devices/{id}/devicegroups/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

GET /devices/{id}/tags

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

POST /devices/{id}/tags

Geben Sie die folgenden Parameter an.

body: Objekt

Eine Liste mit eindeutigen Kennungen für Tags, die dem Gerät zugewiesen und nicht zugewiesen sind.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

POST /devices/{id}/tags/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Tag.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

DELETE /devices/{id}/tags/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Tag.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

GET /devices/{id}/alerts

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

direct_assignments_only: Boolescher Wert

(Optional) Beschränken Sie die Ergebnisse auf Warnmeldungen, die dem Gerät direkt zugewiesen sind.

POST /devices/{id}/alerts

Geben Sie die folgenden Parameter an.

body: Objekt

Die Liste der eindeutigen Kennungen für Alarme, die dem Gerät zugewiesen und nicht zugewiesen sind.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

POST /devices/{id}/alerts/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Alarm.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

DELETE /devices/{id}/alerts/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Alarm.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

GET /devices/{id}/software

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät, die als API-ID auf der Geräteseite im ExtraHop-System angezeigt wird.

from: Zahl

(Optional) Gibt Software zurück, die nach dem angegebenen Datum auf dem Gerät beobachtet wurde, ausgedrückt in Millisekunden seit der Epoche.

until: Zahl

(Optional) Gibt Software zurück, die vor dem angegebenen Datum auf dem Gerät beobachtet wurde, ausgedrückt in Millisekunden seit der Epoche.

GET /exclusionintervals

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "alert_apply_all": true,
    "author": "string",
    "description": "string",
    "end": 0,
    "id": 0,
    "interval_type": "string",
    "mod_time": 0,
    "name": "string",
    "start": 0,
    "trend_apply_all": true
}

POST /exclusionintervals

Geben Sie die folgenden Parameter an.

body: Objekt

Legt die angegebenen Eigenschaftswerte für das neue Ausschlussintervall fest.

name: Schnur

Der freundliche Name für das Ausschlussintervall.

author: Schnur

(Optional) Der Name des Erstellers des Ausschlussintervalls.

description: Schnur

(Optional) Eine optionale Beschreibung des Ausschlussintervalls.

interval_type: Schnur

Das Zeitfenster, in dem das Ausschlussintervall ausgewertet wurde.

Die folgenden Werte sind gültig:

• onetime
• weekly
• daily

start: Zahl

Der Beginn des Zeitbereichs für das Ausschlussintervall, ausgedrückt in Sekunden. Dieser Wert bezieht sich bei einmaligen Ausschlüssen auf die Epoche, bei täglichen Ausschlüssen auf Mitternacht und bei wöchentlichen Ausschlüssen auf Montag um Mitternacht.

end: Zahl

Das Ende des Zeitbereichs für das Ausschlussintervall, ausgedrückt in Sekunden. Dieser Wert bezieht sich bei einmaligen Ausschlüssen auf die Epoche, bei täglichen Ausschlüssen auf Mitternacht und bei wöchentlichen Ausschlüssen auf Montag um Mitternacht.

alert_apply_all: Boolescher Wert

Gibt an, ob dieses Ausschlussintervall auf alle Warnungen angewendet werden soll.

trend_apply_all: Boolescher Wert

Gibt an, ob dieses Ausschlussintervall auf alle Trends angewendet werden soll.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "alert_apply_all": true,
    "author": "string",
    "description": "string",
    "end": 0,
    "interval_type": "string",
    "name": "string",
    "start": 0,
    "trend_apply_all": true
}

Kopieren

GET /exclusionintervals/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung des Ausschlussintervalls.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "alert_apply_all": true,
    "author": "string",
    "description": "string",
    "end": 0,
    "id": 0,
    "interval_type": "string",
    "mod_time": 0,
    "name": "string",
    "start": 0,
    "trend_apply_all": true
}

DELETE /exclusionintervals/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung des Ausschlussintervalls.

PATCH /exclusionintervals/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftswertaktualisierungen auf das Ausschlussintervall an.

id: Zahl

Die eindeutige Kennung für das Ausschlussintervall.

POST /metrics

Geben Sie die folgenden Parameter an.

body: Objekt

Die Beschreibung der Metrikanforderung.

from: Zahl

Der Anfangszeitstempel für die Anfrage. Gibt nur Messwerte zurück, die nach dieser Zeit gesammelt wurden. Die Zeit seit der Epoche wird in Millisekunden ausgedrückt. 0 gibt die Uhrzeit der Anfrage an. Ein negativer Wert wird relativ zur aktuellen Zeit ausgewertet. Die Standardeinheit für einen negativen Wert ist Millisekunden, aber andere Einheiten können mit einem Einheitensuffix angegeben werden. Sehen Sie die REST-API-Leitfaden für unterstützte Zeiteinheiten und Suffixe.

until: Zahl

Der Endzeitstempel für die Anfrage. Gibt nur Metriken zurück, die vor diesem Zeitpunkt gesammelt wurden. Folgt den gleichen Zeitwertrichtlinien wie der Parameter from.

cycle: Schnur

Der Aggregationszeitraum für Metriken.

Die folgenden Werte sind gültig:

• auto
• 1sec
• 30sec
• 5min
• 1hr
• 24hr

object_type: Schnur

Gibt den Objekttyp der eindeutigen Bezeichner an, die in der Eigenschaft object_ids angegeben sind.

Die folgenden Werte sind gültig:

• network
• device
• application
• vlan
• device_group
• system

object_ids: Reihe von Zahlen

Die Liste der numerischen Werte, die eindeutige Bezeichner darstellen. Eindeutige Kennungen können über die Ressourcen /networks, /devices, /applications, /vlans, /devicegroups, /activitygroups und /appliances abgerufen werden. Geben Sie für Systemintegritätsmetriken die ID des Sensor oder der Konsole an und setzen Sie den Parameter object_type auf „system".

metric_category: Schnur

Die Gruppe von Metriken, die im Metrikkatalog durchsucht werden können.

metric_specs: Reihe von Objekten

Eine Reihe von Objekten mit Metrik Spezifikationen.

name: Schnur

Der Feldname für die Metrik. Wenn Sie im Metrikkatalog nach einer metric_category filtern, ist jedes Ergebnis ein potenzieller metric_spec-Name. Wenn ein Ergebnis aus dem Katalog ausgewählt wird, ist der Feldwert „Metrisch" eine gültige Option für dieses Feld.

key1: Schnur

(Optional) Filtern Sie Detailmetriken. Detailmetriken gliedern Daten anhand von Schlüsseln, bei denen es sich um Zeichenketten oder IP-Adressen handelt. Beispielsweise akzeptiert die Metrik „HTTP Requests by Method" den Schlüssel1-Wert „GET". Schlüssel können auch reguläre Ausdrücke sein, die durch Schrägstriche („/GET/") getrennt sind.

key2: Schnur

(Optional) Aktivieren Sie zusätzliche Filterung von Detailmetriken.

calc_type: Schnur

(Optional) Die Art der auszuführenden Berechnung.

Die folgenden Werte sind gültig:

• mean
• percentiles

percentiles: Reihe von Zahlen

(Optional) Die Liste der Perzentile, sortiert in aufsteigender Reihenfolge, die zurückgegeben werden sollen. Dieser Parameter ist nur erforderlich, wenn der Parameter calc_type auf „Perzentile" gesetzt ist. Wenn der Parameter calc_type auf mean gesetzt ist, kann die Perzentile-Eigenschaft nicht festgelegt werden.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "cycle": "string",
    "from": 0,
    "metric_category": "string",
    "metric_specs": {
        "name": "string",
        "key1": "string",
        "key2": "string",
        "calc_type": "string",
        "percentiles": []
    },
    "object_ids": [],
    "object_type": "string",
    "until": 0
}

Kopieren

POST /metrics/total

Geben Sie die folgenden Parameter an.

body: Objekt

Die Beschreibung der Metrikanforderung.

from: Zahl

Der Anfangszeitstempel für die Anfrage. Gibt nur Messwerte zurück, die nach dieser Zeit gesammelt wurden. Die Zeit seit der Epoche wird in Millisekunden ausgedrückt. 0 gibt die Uhrzeit der Anfrage an. Ein negativer Wert wird relativ zur aktuellen Zeit ausgewertet. Die Standardeinheit für einen negativen Wert ist Millisekunden, aber andere Einheiten können mit einem Einheitensuffix angegeben werden. Sehen Sie die REST-API-Leitfaden für unterstützte Zeiteinheiten und Suffixe.

until: Zahl

Der Endzeitstempel für die Anfrage. Gibt nur Metriken zurück, die vor diesem Zeitpunkt gesammelt wurden. Folgt den gleichen Zeitwertrichtlinien wie der Parameter from.

cycle: Schnur

Der Aggregationszeitraum für Metriken.

Die folgenden Werte sind gültig:

• auto
• 1sec
• 30sec
• 5min
• 1hr
• 24hr

object_type: Schnur

Gibt den Objekttyp der eindeutigen Bezeichner an, die in der Eigenschaft object_ids angegeben sind.

Die folgenden Werte sind gültig:

• network
• device
• application
• vlan
• device_group
• system

object_ids: Reihe von Zahlen

Die Liste der numerischen Werte, die eindeutige Bezeichner darstellen. Eindeutige Kennungen können über die Ressourcen /networks, /devices, /applications, /vlans, /devicegroups, /activitygroups und /appliances abgerufen werden. Geben Sie für Systemintegritätsmetriken die ID des Sensor oder der Konsole an und setzen Sie den Parameter object_type auf „system".

metric_category: Schnur

Die Gruppe von Metriken, die im Metrikkatalog durchsucht werden können.

metric_specs: Reihe von Objekten

Eine Reihe von Objekten mit Metrik Spezifikationen.

name: Schnur

Der Feldname für die Metrik. Wenn Sie im Metrikkatalog nach einer metric_category filtern, ist jedes Ergebnis ein potenzieller metric_spec-Name. Wenn ein Ergebnis aus dem Katalog ausgewählt wird, ist der Feldwert „Metrisch" eine gültige Option für dieses Feld.

key1: Schnur

(Optional) Filtern Sie Detailmetriken. Detailmetriken gliedern Daten anhand von Schlüsseln, bei denen es sich um Zeichenketten oder IP-Adressen handelt. Beispielsweise akzeptiert die Metrik „HTTP Requests by Method" den Schlüssel1-Wert „GET". Schlüssel können auch reguläre Ausdrücke sein, die durch Schrägstriche („/GET/") getrennt sind.

key2: Schnur

(Optional) Aktivieren Sie zusätzliche Filterung von Detailmetriken.

calc_type: Schnur

(Optional) Die Art der auszuführenden Berechnung.

Die folgenden Werte sind gültig:

• mean
• percentiles

percentiles: Reihe von Zahlen

(Optional) Die Liste der Perzentile, sortiert in aufsteigender Reihenfolge, die zurückgegeben werden sollen. Dieser Parameter ist nur erforderlich, wenn der Parameter calc_type auf „Perzentile" gesetzt ist. Wenn der Parameter calc_type auf mean gesetzt ist, kann die Perzentile-Eigenschaft nicht festgelegt werden.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "cycle": "string",
    "from": 0,
    "metric_category": "string",
    "metric_specs": {
        "name": "string",
        "key1": "string",
        "key2": "string",
        "calc_type": "string",
        "percentiles": []
    },
    "object_ids": [],
    "object_type": "string",
    "until": 0
}

Kopieren

POST /metrics/totalbyobject

Geben Sie die folgenden Parameter an.

body: Objekt

Die Beschreibung der Metrikanforderung.

from: Zahl

Der Anfangszeitstempel für die Anfrage. Gibt nur Messwerte zurück, die nach dieser Zeit gesammelt wurden. Die Zeit seit der Epoche wird in Millisekunden ausgedrückt. 0 gibt die Uhrzeit der Anfrage an. Ein negativer Wert wird relativ zur aktuellen Zeit ausgewertet. Die Standardeinheit für einen negativen Wert ist Millisekunden, aber andere Einheiten können mit einem Einheitensuffix angegeben werden. Sehen Sie die REST-API-Leitfaden für unterstützte Zeiteinheiten und Suffixe.

until: Zahl

Der Endzeitstempel für die Anfrage. Gibt nur Metriken zurück, die vor diesem Zeitpunkt gesammelt wurden. Folgt den gleichen Zeitwertrichtlinien wie der Parameter from.

cycle: Schnur

Der Aggregationszeitraum für Metriken.

Die folgenden Werte sind gültig:

• auto
• 1sec
• 30sec
• 5min
• 1hr
• 24hr

object_type: Schnur

Gibt den Objekttyp der eindeutigen Bezeichner an, die in der Eigenschaft object_ids angegeben sind.

Die folgenden Werte sind gültig:

• network
• device
• application
• vlan
• device_group
• system

object_ids: Reihe von Zahlen

Die Liste der numerischen Werte, die eindeutige Bezeichner darstellen. Eindeutige Kennungen können über die Ressourcen /networks, /devices, /applications, /vlans, /devicegroups, /activitygroups und /appliances abgerufen werden. Geben Sie für Systemintegritätsmetriken die ID des Sensor oder der Konsole an und setzen Sie den Parameter object_type auf „system".

metric_category: Schnur

Die Gruppe von Metriken, die im Metrikkatalog durchsucht werden können.

metric_specs: Reihe von Objekten

Eine Reihe von Objekten mit Metrik Spezifikationen.

name: Schnur

Der Feldname für die Metrik. Wenn Sie im Metrikkatalog nach einer metric_category filtern, ist jedes Ergebnis ein potenzieller metric_spec-Name. Wenn ein Ergebnis aus dem Katalog ausgewählt wird, ist der Feldwert „Metrisch" eine gültige Option für dieses Feld.

key1: Schnur

(Optional) Filtern Sie Detailmetriken. Detailmetriken gliedern Daten anhand von Schlüsseln, bei denen es sich um Zeichenketten oder IP-Adressen handelt. Beispielsweise akzeptiert die Metrik „HTTP Requests by Method" den Schlüssel1-Wert „GET". Schlüssel können auch reguläre Ausdrücke sein, die durch Schrägstriche („/GET/") getrennt sind.

key2: Schnur

(Optional) Aktivieren Sie zusätzliche Filterung von Detailmetriken.

calc_type: Schnur

(Optional) Die Art der auszuführenden Berechnung.

Die folgenden Werte sind gültig:

• mean
• percentiles

percentiles: Reihe von Zahlen

(Optional) Die Liste der Perzentile, sortiert in aufsteigender Reihenfolge, die zurückgegeben werden sollen. Dieser Parameter ist nur erforderlich, wenn der Parameter calc_type auf „Perzentile" gesetzt ist. Wenn der Parameter calc_type auf mean gesetzt ist, kann die Perzentile-Eigenschaft nicht festgelegt werden.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "cycle": "string",
    "from": 0,
    "metric_category": "string",
    "metric_specs": {
        "name": "string",
        "key1": "string",
        "key2": "string",
        "calc_type": "string",
        "percentiles": []
    },
    "object_ids": [],
    "object_type": "string",
    "until": 0
}

Kopieren

GET /metrics/next/{xid}

Geben Sie die folgenden Parameter an.

xid: Zahl

Der eindeutige Bezeichner, der von einer Metrikabfrage zurückgegeben wurde.

GET /networklocalities

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "description": "string",
    "external": true,
    "id": 0,
    "mod_time": 0,
    "name": "string",
    "network": "string",
    "networks": []
}

POST /networklocalities

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftswerte auf den neuen Eintrag für die Netzwerklokalität an.

name: Schnur

(Optional) Der Name der Netzwerklokalität. Wenn dieses Feld nicht angegeben ist, wird die Netzwerklokalität im folgenden Format benannt: „Locality_ID", wobei ID die eindeutige Kennung der Netzwerklokalität ist.

network: Schnur

(Optional) Veraltet. Geben Sie CIDR-Blöcke oder IP-Adressen im Feld Netzwerke an.

networks: Reihe von Zeichenketten

(Optional) Eine Reihe von CIDR-Blöcken oder IP-Adressen, die die Netzwerklokalität definieren.

external: Boolescher Wert

Gibt an, ob das Netzwerk intern oder extern ist.

description: Schnur

(Optional) Eine optionale Beschreibung des Eintrags zur Netzwerklokalität.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "description": "string",
    "external": true,
    "name": "string",
    "network": "string",
    "networks": []
}

Kopieren

GET /networklocalities/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Eintrag zur Netzwerklokalität.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "description": "string",
    "external": true,
    "id": 0,
    "mod_time": 0,
    "name": "string",
    "network": "string",
    "networks": []
}

DELETE /networklocalities/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Eintrag zur Netzwerklokalität.

PATCH /networklocalities/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftswertaktualisierungen auf den Eintrag für die Netzwerklokalität an.

network: Schnur

(Optional) Veraltet. Geben Sie CIDR-Blöcke oder IP-Adressen im Feld Netzwerke an.

networks: Reihe von Zeichenketten

(Optional) Eine Reihe von CIDR-Blöcken oder IP-Adressen, die die Netzwerklokalität definieren.

name: Schnur

(Optional) Der Name der Netzwerklokalität.

external: Boolescher Wert

(Optional) Gibt an, ob das Netzwerk intern oder extern ist.

description: Schnur

(Optional) Eine optionale Beschreibung des Eintrags zur Netzwerklokalität.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "description": "string",
    "external": true,
    "name": "string",
    "network": "string",
    "networks": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für den Eintrag zur Netzwerklokalität.

GET /networks

Für diesen Vorgang gibt es keine Parameter.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "appliance_uuid": "string",
    "description": "string",
    "id": 0,
    "idle": true,
    "mod_time": 0,
    "name": "string",
    "node_id": 0
}

PATCH /networks/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Eigenschaftswertaktualisierungen, die auf das Netzwerk angewendet werden sollen.

id: Zahl

Eindeutige Kennung des Netzwerk.

GET /networks/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Eindeutige Kennung des Netzwerk.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "appliance_uuid": "string",
    "description": "string",
    "id": 0,
    "idle": true,
    "mod_time": 0,
    "name": "string",
    "node_id": 0
}

GET /networks/{id}/alerts

Geben Sie die folgenden Parameter an.

id: Zahl

Eindeutige Kennung des Netzwerk.

direct_assignments_only: Boolescher Wert

(Optional) Beschränken Sie die Ergebnisse auf Warnmeldungen, die dem Netzwerk direkt zugewiesen sind.

POST /networks/{id}/alerts

Geben Sie die folgenden Parameter an.

body: Objekt

Listen von Alert-IDs, die zugewiesen und/oder aufgehoben werden sollen.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Eindeutige Kennung des Netzwerk.

POST /networks/{id}/alerts/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Eindeutige Kennung der Alarm.

id: Zahl

Eindeutige Kennung des Netzwerk.

DELETE /networks/{id}/alerts/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Eindeutige Kennung der Alarm.

id: Zahl

Eindeutige Kennung des Netzwerk.

GET /networks/{id}/vlans

Geben Sie die folgenden Parameter an.

id: Zahl

Eindeutige Kennung des Netzwerk.

POST /observations/associatedipaddrs

Geben Sie die folgenden Parameter an.

body: Objekt

Die Beobachtungsparameter.

observations: Reihe von Objekten

Eine Reihe von Beobachtungen.

ipaddr: Schnur

Die vom Sensor oder der Konsole beobachtete Geräte-IP-Adresse.

associated_ipaddr: Schnur

Die zugehörige IP-Adresse.

timestamp: Zahl

Die Zeit, in der die Beobachtung von der Quelle erstellt wurde, ausgedrückt in Millisekunden seit der Epoche.

source: Schnur

Die Quelle der Beobachtungen.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "observations": {
        "ipaddr": "string",
        "associated_ipaddr": "string",
        "timestamp": 0
    },
    "source": "string"
}

Kopieren

POST /pairing/token

Für diesen Vorgang gibt es keine Parameter.

GET /reports

Für diesen Vorgang gibt es keine Parameter.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "cc": [],
    "description": "string",
    "email_message": "string",
    "email_subject": "string",
    "enabled": true,
    "from": "string",
    "id": 0,
    "include_links": "string",
    "name": "string",
    "output": {},
    "owner": "string",
    "schedule": {},
    "until": "string"
}

POST /reports

Geben Sie die folgenden Parameter an.

body: Objekt

Der Inhalt des Berichts.

name: Schnur

Der Name des Berichts.

description: Schnur

(Optional) Die Beschreibung des Berichts.

owner: Schnur

Der Benutzername des Berichtsbesitzers.

cc: Reihe von Zeichenketten

Die Liste der E-Mail-Adressen, die nicht in einer E-Mail-Gruppe enthalten sind, um Berichte zu erhalten.

enabled: Boolescher Wert

(Optional) Gibt an, ob der Bericht aktiviert ist.

from: Schnur

Der Anfangszeitstempel des Zeitintervalls für den Berichtsinhalt, relativ zur aktuellen Zeit, ausgedrückt in Millisekunden.

until: Schnur

(Optional) Der Endzeitstempel des Zeitintervalls für den Berichtsinhalt, relativ zur aktuellen Uhrzeit und ausgedrückt in Millisekunden.

email_subject: Schnur

(Optional) Der Inhalt der Betreffzeile für die Berichts-E-Mail.

schedule: Objekt

(Optional) Das Objekt, das die Parameter enthält, die den geplanten Zeitraum für die Generierung und den Versand des Berichts angeben. Die Parameter werden im Abschnitt schedule_type unten definiert.

type: Schnur

Die Art des Lieferplans für den Bericht.

Die folgenden Werte sind gültig:

• hourly
• daily
• weekly

at: Reihe von Objekten

(Optional) Die Liste der Objekte, die die Übermittlungsparameter für den Bericht angeben. Die Parameter werden im Abschnitt at_type unten definiert.

by_day: Reihe von Zeichenketten

(Optional) Die Wochentage, an denen der Bericht gesendet werden soll.

Die folgenden Werte sind gültig:

• mo
• tu
• we
• th
• fr
• sa
• su

tz: Schnur

(Optional) Die Zeitzone, in der der Bericht gesendet werden soll.

hour: Zahl

(Optional) Die Stunde, zu der der Bericht gesendet werden soll.

minute: Zahl

(Optional) Die Minute, in der der Bericht gesendet werden soll.

output: Objekt

Das Objekt, das die Parameter enthält, die das Ausgabeformat für den Bericht angeben. Die Parameter werden im Abschnitt format_type unten definiert.

type: Schnur

Das Ausgabeformat für den Bericht.

Die folgenden Werte sind gültig:

• pdf

width: Schnur

(Optional) Die Breitenoption für die Berichtsausgabe.

Die folgenden Werte sind gültig:

• narrow
• medium
• wide

pagination: Schnur

(Optional) Das Paginierungsschema für die Berichtsausgabe.

Die folgenden Werte sind gültig:

• per_region

theme: Schnur

(Optional) Das Anzeigedesign für die Berichtsausgabe.

Die folgenden Werte sind gültig:

• light
• dark
• space
• contrast

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "cc": [],
    "description": "string",
    "email_subject": "string",
    "enabled": true,
    "from": "string",
    "name": "string",
    "output": {
        "type": "string",
        "width": "string",
        "pagination": "string",
        "theme": "string"
    },
    "owner": "string",
    "schedule": {
        "type": "string",
        "at": {
            "by_day": [],
            "tz": "string",
            "hour": 0,
            "minute": 0
        }
    },
    "until": "string"
}

Kopieren

POST /reports/{id}/queue

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Bericht.

PATCH /reports/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Bericht.

body: Objekt

Der Inhalt des Berichts.

name: Schnur

Der Name des Berichts.

description: Schnur

(Optional) Die Beschreibung des Berichts.

owner: Schnur

Der Benutzername des Berichtsbesitzers.

cc: Reihe von Zeichenketten

Die Liste der E-Mail-Adressen, die nicht in einer E-Mail-Gruppe enthalten sind, um Berichte zu erhalten.

enabled: Boolescher Wert

(Optional) Gibt an, ob der Bericht aktiviert ist.

from: Schnur

Der Anfangszeitstempel des Zeitintervalls für den Berichtsinhalt, relativ zur aktuellen Zeit, ausgedrückt in Millisekunden.

until: Schnur

(Optional) Der Endzeitstempel des Zeitintervalls für den Berichtsinhalt, relativ zur aktuellen Uhrzeit und ausgedrückt in Millisekunden.

email_subject: Schnur

(Optional) Der Inhalt der Betreffzeile für die Berichts-E-Mail.

schedule: Objekt

(Optional) Das Objekt, das die Parameter enthält, die den geplanten Zeitraum für die Generierung und den Versand des Berichts angeben. Die Parameter werden im Abschnitt schedule_type unten definiert.

type: Schnur

Die Art des Lieferplans für den Bericht.

Die folgenden Werte sind gültig:

• hourly
• daily
• weekly

at: Reihe von Objekten

(Optional) Die Liste der Objekte, die die Übermittlungsparameter für den Bericht angeben. Die Parameter werden im Abschnitt at_type unten definiert.

by_day: Reihe von Zeichenketten

(Optional) Die Wochentage, an denen der Bericht gesendet werden soll.

Die folgenden Werte sind gültig:

• mo
• tu
• we
• th
• fr
• sa
• su

tz: Schnur

(Optional) Die Zeitzone, in der der Bericht gesendet werden soll.

hour: Zahl

(Optional) Die Stunde, zu der der Bericht gesendet werden soll.

minute: Zahl

(Optional) Die Minute, in der der Bericht gesendet werden soll.

output: Objekt

Das Objekt, das die Parameter enthält, die das Ausgabeformat für den Bericht angeben. Die Parameter werden im Abschnitt format_type unten definiert.

type: Schnur

Das Ausgabeformat für den Bericht.

Die folgenden Werte sind gültig:

• pdf

width: Schnur

(Optional) Die Breitenoption für die Berichtsausgabe.

Die folgenden Werte sind gültig:

• narrow
• medium
• wide

pagination: Schnur

(Optional) Das Paginierungsschema für die Berichtsausgabe.

Die folgenden Werte sind gültig:

• per_region

theme: Schnur

(Optional) Das Anzeigedesign für die Berichtsausgabe.

Die folgenden Werte sind gültig:

• light
• dark
• space
• contrast

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "cc": [],
    "description": "string",
    "email_subject": "string",
    "enabled": true,
    "from": "string",
    "name": "string",
    "output": {
        "type": "string",
        "width": "string",
        "pagination": "string",
        "theme": "string"
    },
    "owner": "string",
    "schedule": {
        "type": "string",
        "at": {
            "by_day": [],
            "tz": "string",
            "hour": 0,
            "minute": 0
        }
    },
    "until": "string"
}

Kopieren

GET /reports/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Bericht.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "cc": [],
    "description": "string",
    "email_message": "string",
    "email_subject": "string",
    "enabled": true,
    "from": "string",
    "id": 0,
    "include_links": "string",
    "name": "string",
    "output": {},
    "owner": "string",
    "schedule": {},
    "until": "string"
}

GET /reports/{id}/download

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Bericht.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "cc": [],
    "description": "string",
    "email_message": "string",
    "email_subject": "string",
    "enabled": true,
    "from": "string",
    "id": 0,
    "include_links": "string",
    "name": "string",
    "output": {},
    "owner": "string",
    "schedule": {},
    "until": "string"
}

DELETE /reports/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Bericht.

GET /reports/{id}/contents

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Bericht.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "dashboard_id": 0,
    "params": {},
    "type": "string"
}

PUT /reports/{id}/contents

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Bericht.

body: Objekt

Der Inhalt des Berichts.

GET /tags

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "id": 0,
    "mod_time": 0,
    "name": "string"
}

POST /tags

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftswerte auf das neue Tag an.

name: Schnur

Der Zeichenkettenwert für das Tag.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "name": "string"
}

Kopieren

GET /tags/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Tag.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "id": 0,
    "mod_time": 0,
    "name": "string"
}

DELETE /tags/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Tag.

PATCH /tags/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Wendet die angegebenen Eigenschaftswertaktualisierungen auf das Tag an.

id: Zahl

Die eindeutige Kennung für das Tag.

GET /tags/{id}/devices

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Tag.

POST /tags/{id}/devices

Geben Sie die folgenden Parameter an.

body: Objekt

Listen mit eindeutigen Kennungen für Gerät zum Zuweisen und Aufheben der Zuweisung.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für das Tag.

POST /tags/{id}/devices/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Gerät.

id: Zahl

die eindeutige Kennung für das Tag.

DELETE /tags/{id}/devices/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Gerät.

id: Zahl

Die eindeutige Kennung für das Tag.

GET /triggers

Für diesen Vorgang gibt es keine Parameter.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "apply_all": true,
    "author": "string",
    "debug": true,
    "description": "string",
    "disabled": true,
    "event": "string",
    "events": [
        "string"
    ],
    "hints": {},
    "id": 0,
    "mod_time": 0,
    "name": "string",
    "script": "string"
}

DELETE /triggers/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Auslöser.

POST /triggers/externaldata

Geben Sie die folgenden Parameter an.

body: Objekt

Das Objekt, das die Daten enthält, die über das EXTERNAL_DATA-Ereignis an Trigger gesendet werden sollen.

type: Schnur

Ein Zeichenkettenbezeichner, der die im Body-Parameter enthaltenen Daten beschreibt. Sie könnten beispielsweise „Phantom-Daten" für Daten angeben, die von der Phantom SOAR-Plattform gesendet werden.

body: Objekt

Die Daten, die über das EXTERNAL_DATA-Ereignis an Trigger gesendet werden sollen. Auf diese Daten kann im Auslöser mit der Eigenschaft 'ExternalData.Body' zugegriffen werden.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "body": {},
    "type": "string"
}

Kopieren

POST /triggers

Geben Sie die folgenden Parameter an.

body: Objekt

Die Eigenschaftswerte für den neuen Auslöser.

name: Schnur

Der freundliche Name für den Auslöser.

description: Schnur

(Optional) Eine optionale Beschreibung des Auslöser.

author: Schnur

Der Name des Erstellers des Auslöser.

script: Schnur

Der JavaScript-Inhalt des Auslöser.

event: Schnur

(Optional) Veraltet. Ersetzt durch das Feld Ereignisse.

events: Reihe von Zeichenketten

Die Liste der Ereignisse, für die der Auslöser ausgeführt wird, ausgedrückt als JSON-Array.

disabled: Boolescher Wert

Gibt an, ob der Auslöser ausgeführt werden kann.

debug: Boolescher Wert

Gibt an, ob Debug-Anweisungen für den Auslöser gedruckt werden.

apply_all: Boolescher Wert

Gibt an, ob der Auslöser für alle relevanten Ressourcen gilt.

hints: Objekt

Optionen, die auf ausgewählten Triggerereignissen basieren. Weitere Informationen zum Hints-Objekt finden Sie in der REST-API-Leitfaden.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "apply_all": true,
    "author": "string",
    "debug": true,
    "description": "string",
    "disabled": true,
    "event": "string",
    "events": [
        "string"
    ],
    "hints": {},
    "name": "string",
    "script": "string"
}

Kopieren

PATCH /triggers/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Der Eigenschaftswert wird für den Auslöser aktualisiert.

id: Zahl

Die eindeutige Kennung für den Auslöser.

GET /triggers/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Auslöser.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "apply_all": true,
    "author": "string",
    "debug": true,
    "description": "string",
    "disabled": true,
    "event": "string",
    "events": [
        "string"
    ],
    "hints": {},
    "id": 0,
    "mod_time": 0,
    "name": "string",
    "script": "string"
}

GET /triggers/{id}/devicegroups

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Auslöser.

POST /triggers/{id}/devicegroups

Geben Sie die folgenden Parameter an.

body: Objekt

Eine Liste mit eindeutigen Kennungen für Gerätegruppen, die einem Auslöser zugewiesen oder nicht zugewiesen sind.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für den Auslöser.

POST /triggers/{id}/devicegroups/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

id: Zahl

Die eindeutige Kennung für den Auslöser.

DELETE /triggers/{id}/devicegroups/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für die Gerätegruppe.

id: Zahl

Die eindeutige Kennung für den Auslöser.

GET /triggers/{id}/devices

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für den Auslöser.

POST /triggers/{id}/devices

Geben Sie die folgenden Parameter an.

body: Objekt

Eine Liste mit eindeutigen Kennungen für Geräte, die einem Auslöser zugewiesen oder nicht zugewiesen sind.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren

id: Zahl

Die eindeutige Kennung für den Auslöser.

POST /triggers/{id}/devices/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Gerät.

id: Zahl

Die eindeutige Kennung für den Auslöser.

DELETE /triggers/{id}/devices/{child-id}

Geben Sie die folgenden Parameter an.

child-id: Zahl

Die eindeutige Kennung für das Gerät.

id: Zahl

Die eindeutige Kennung für den Auslöser.

GET /usergroups

Für diesen Vorgang gibt es keine Parameter.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "display_name": "string",
    "enabled": true,
    "id": "string",
    "is_remote": true,
    "last_sync_time": 0,
    "name": "string",
    "rights": []
}

POST /usergroups

Geben Sie die folgenden Parameter an.

body: Objekt

Die Eigenschaften der Benutzergruppe.

name: Schnur

Der Name der Benutzergruppe.

enabled: Boolescher Wert

Zeigt an, ob die Benutzergruppe aktiviert ist.

Geben Sie den Body-Parameter im folgenden JSON-Format an.

{
    "enabled": true,
    "name": "string"
}

Kopieren

PATCH /usergroups/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Der Eigenschaftswert wird für die spezifische Benutzergruppe aktualisiert.

id: Schnur

Die eindeutige Kennung für die Benutzergruppe.

GET /usergroups/{id}

Geben Sie die folgenden Parameter an.

id: Schnur

Die eindeutige Kennung für die Benutzergruppe.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "display_name": "string",
    "enabled": true,
    "id": "string",
    "is_remote": true,
    "last_sync_time": 0,
    "name": "string",
    "rights": []
}

DELETE /usergroups/{id}

Geben Sie die folgenden Parameter an.

id: Schnur

Die eindeutige Kennung für die Benutzergruppe.

DELETE /usergroups/{id}/associations

Geben Sie die folgenden Parameter an.

id: Schnur

Die eindeutige Kennung für die Benutzergruppe.

GET /usergroups/{id}/members

Geben Sie die folgenden Parameter an.

id: Schnur

Die eindeutige Kennung für die Benutzergruppe.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "users": {}
}

PATCH /usergroups/{id}/members

Geben Sie die folgenden Parameter an.

id: Schnur

Die eindeutige Kennung für die Benutzergruppe.

body: Schnur

Ein Objekt, das angibt, welche Benutzer zugewiesen oder welche Zuweisung aufgehoben werden sollen. Jeder Schlüssel muss ein Benutzername sein und jeder Wert muss entweder „Mitglied" oder Null sein. Zum Beispiel weist {"Alice": „member", „Bob": null} Alice der Gruppe zu und trennt Bob von der Gruppe.

PUT /usergroups/{id}/members

Geben Sie die folgenden Parameter an.

id: Schnur

Die eindeutige Kennung für die Benutzergruppe.

body: Schnur

Ein Objekt, das angibt, welche Benutzer der Gruppe zugewiesen sind. Jeder Schlüssel muss ein Benutzername sein und jeder Wert muss „Mitglied" sein. Zum Beispiel weist {"Alice": „member", „Bob": „member"} Alice und Bob als einzige Mitglieder der Gruppe zu.

GET /vlans

Für diesen Vorgang gibt es keine Parameter.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "description": "string",
    "id": 0,
    "mod_time": 0,
    "name": "string",
    "network_id": 0,
    "node_id": 0,
    "vlanid": 0
}

GET /vlans/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das VLAN.

Wenn die Anfrage erfolgreich ist, gibt das ExtraHop-System ein Objekt im folgenden Format zurück.

{
    "description": "string",
    "id": 0,
    "mod_time": 0,
    "name": "string",
    "network_id": 0,
    "node_id": 0,
    "vlanid": 0
}

PATCH /vlans/{id}

Geben Sie die folgenden Parameter an.

body: Objekt

Wenden Sie die angegebenen Eigenschaftswertaktualisierungen auf das VLAN an.

id: Zahl

Die eindeutige Kennung für das VLAN.

GET /watchlist/devices

Für diesen Vorgang gibt es keine Parameter.

POST /watchlist/device/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät.

DELETE /watchlist/device/{id}

Geben Sie die folgenden Parameter an.

id: Zahl

Die eindeutige Kennung für das Gerät.

POST /watchlist/devices

Geben Sie die folgenden Parameter an.

assignments: Objekt

Eine Liste von Geräten, die zur Beobachtungsliste hinzugefügt oder daraus entfernt werden sollen.

assign: Reihe von Zahlen

IDs der zuzuweisenden Ressourcen

unassign: Reihe von Zahlen

IDs der Ressourcen, deren Zuweisung aufgehoben werden soll

Geben Sie den Zuweisungsparameter im folgenden JSON-Format an.

{
    "assign": [],
    "unassign": []
}

Kopieren