Guide de l'API REST du capteur IDS

GET /apikeys

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "description": "string",
    "id": 0,
    "key": "string",
    "time_added": 0,
    "user_id": 0,
    "username": "string"
}

GET /apikeys/{keyid}

Spécifiez les paramètres suivants.

keyid: Numéro

Identifiant unique de la clé d'API.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "description": "string",
    "id": 0,
    "key": "string",
    "time_added": 0,
    "user_id": 0,
    "username": "string"
}

POST /apikeys

Spécifiez les paramètres suivants.

body: Objet

Le mot de passe de l'utilisateur d'installation.

password: Corde

Le mot de passe de l'utilisateur d'installation.

Spécifiez le paramètre body au format JSON suivant.

{
    "password": "string"
}

Copier

GET /auditlog

Spécifiez les paramètres suivants.

limit: Numéro

(Facultatif) Nombre maximal de messages de journal à renvoyer.

offset: Numéro

(Facultatif) Nombre de messages de journal à ignorer dans les résultats. Renvoie les messages du journal à partir de la valeur de décalage.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

POST /cloud/connect

Spécifiez les paramètres suivants.

body: Objet

Le jeton que vous avez généré à partir de RevealX 360.

cloud_token: Corde

Le jeton que vous avez généré à partir de RevealX 360.

nickname: Corde

Un surnom permettant d'identifier facilement la sonde.

Spécifiez le paramètre body au format JSON suivant.

{
    "cloud_token": "string",
    "nickname": "string"
}

Copier

GET /emailgroups

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "email_addresses": [],
    "group_name": "string",
    "id": 0,
    "system_notifications": true
}

POST /emailgroups

Spécifiez les paramètres suivants.

body: Objet

Appliquez les valeurs de propriétés spécifiées au nouveau groupe de messagerie.

group_name: Corde

Nom convivial du groupe de messagerie.

email_addresses: Tableau de chaînes

Liste des adresses e-mail du groupe de messagerie.

system_notifications: Booléen

Indique si le groupe doit recevoir des notifications du système.

Spécifiez le paramètre body au format JSON suivant.

{
    "email_addresses": [],
    "group_name": "string",
    "system_notifications": true
}

Copier

GET /emailgroups/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du groupe de messagerie.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "email_addresses": [],
    "group_name": "string",
    "id": 0,
    "system_notifications": true
}

DELETE /emailgroups/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du groupe de messagerie.

PATCH /emailgroups/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour des valeurs de propriété spécifiées au groupe de messagerie.

id: Numéro

Identifiant unique du groupe de messagerie.

GET /extrahop/version

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "version": "string"
}

GET /extrahop/platform

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "platform": "string"
}

GET /extrahop/edition

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "edition": "string"
}

GET /extrahop

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "display_host": "string",
    "external_hostname": "string",
    "hostname": "string",
    "mgmt_ipaddr": "string",
    "platform": "string",
    "version": "string"
}

GET /extrahop/idrac

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "ipaddr": "string"
}

POST /extrahop/sslcert

Il n'existe aucun paramètre pour cette opération.

PUT /extrahop/sslcert

Spécifiez les paramètres suivants.

body: Corde

Le certificat SSL et éventuellement la clé privée. Entrez en texte brut, séparé par un saut de ligne.

POST /extrahop/sslcert/signingrequest

Spécifiez les paramètres suivants.

body: Objet

Paramètres de la demande de signature de certificat SSL.

subject_alternative_names: Tableau d'objets

Liste des noms auxquels le certificat s'applique, tels que {"type » : « dns », « name » : « www.example.com"}.

type: Corde

Type de sujet Nom alternatif.

Les valeurs suivantes sont valides :

• dns
• ip

name: Corde

Nom du sujet Nom alternatif.

subject: Objet

L'objet du certificat SSL. Pour consulter la liste des sujets du certificat, voir ci-dessous.

common_name: Corde

Le nom commun du sujet (CN).

country_code: Corde

(Facultatif) Le pays concerné (C).

state_or_province_name: Corde

(Facultatif) L'État ou la province concernés (ST).

locality_name: Corde

(Facultatif) La localité concernée (L).

organization_name: Corde

(Facultatif) L'organisation concernée (O).

organizational_unit_name: Corde

(Facultatif) L'unité organisationnelle (OU) concernée.

email_address: Corde

(Facultatif) L'adresse e-mail objet (EmailAddress).

Spécifiez le paramètre body au format JSON suivant.

{
    "subject": {
        "common_name": "string",
        "country_code": "string",
        "state_or_province_name": "string",
        "locality_name": "string",
        "organization_name": "string",
        "organizational_unit_name": "string",
        "email_address": "string"
    },
    "subject_alternative_names": {
        "type": "string",
        "name": "string"
    }
}

Copier

GET /extrahop/ticketing

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "enabled": true,
    "external_ticketing_enabled": true,
    "internal_ticketing_enabled": true,
    "url_template": "string"
}

PATCH /extrahop/ticketing

Spécifiez les paramètres suivants.

body: Objet

Paramètres de suivi des tickets.

enabled: Booléen

(Facultatif) Obsolète. Remplacé par les champs external_ticketing_enabled et internal_ticketing_enabled.

external_ticketing_enabled: Booléen

(Facultatif) Indique si les détections sont suivies à partir d'un système de billetterie externe. Ce champ est obligatoire si le champ internal_ticketing_enabled est spécifié.

internal_ticketing_enabled: Booléen

(Facultatif) Indique si les détections sont suivies depuis le système ExtraHop. Ce champ est obligatoire si le champ external_ticketing_enabled est spécifié.

url_template: Corde

(Facultatif) Modèle d'URL qui relie les détections à des tickets externes. Le modèle doit inclure la variable $ticket_id. Ce champ s'applique uniquement si les détections sont suivies à partir d'un système de billetterie externe.

Spécifiez le paramètre body au format JSON suivant.

{
    "enabled": true,
    "external_ticketing_enabled": true,
    "internal_ticketing_enabled": true,
    "url_template": "string"
}

Copier

PUT /extrahop/detections/access

Spécifiez les paramètres suivants.

body: Objet

Les paramètres d'accès aux détections pour l'appliance.

enabled: Booléen

Indique si les paramètres d'accès aux détections sont activés. Lorsque cette option est activée, les administrateurs peuvent restreindre l'accès aux détections à des utilisateurs spécifiques. Vous ne pouvez pas désactiver les paramètres d'accès aux détections une fois ceux-ci activés.

Spécifiez le paramètre body au format JSON suivant.

{
    "enabled": true
}

Copier

GET /extrahop/detections/access

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "enabled": true
}

POST /extrahop/firmware

Spécifiez les paramètres suivants.

firmware: Nom de fichier

Le fichier .tar qui contient l'image du microprogramme. Remarque : Vous ne pouvez pas télécharger d'image de microprogramme via l'explorateur d'API REST. Pour plus d'informations sur la façon de télécharger une image via cURL ou un script Python, voir Mettez à niveau le firmware ExtraHop via l'API REST.

POST /extrahop/firmware/latest/upgrade

Spécifiez les paramètres suivants.

body: Objet

(Facultatif) Les options d'installation pour la mise à niveau de l'appliance.

restart_after: Booléen

(Facultatif) Indique s'il faut redémarrer l'appliance une fois la mise à niveau terminée.

silent: Booléen

(Facultatif) Spécifie s'il faut désactiver l'interface utilisateur Web ExtraHop pendant le processus de mise à niveau. En cas d'échec d'une mise à niveau, l'appliance revient automatiquement à la version précédente du microprogramme.

force: Booléen

(Facultatif) Spécifie s'il faut ignorer la vérification de compatibilité. Ignorez la vérification uniquement si le support ExtraHop a examiné et approuvé la mise à niveau.

Spécifiez le paramètre body au format JSON suivant.

{
    "force": true,
    "restart_after": true,
    "silent": true
}

Copier

POST /extrahop/firmware/download/url

Spécifiez les paramètres suivants.

body: Objet

Les options de téléchargement.

firmware_url: Corde

URL du microprogramme à télécharger. Les schémas HTTPS, HTTP et FTP sont pris en charge.

upgrade: Booléen

(Facultatif) Spécifie s'il faut mettre à niveau l'appliance une fois le téléchargement du microprogramme terminé.

force: Booléen

(Facultatif) Spécifie s'il faut ignorer la vérification de compatibilité. Ignorez la vérification uniquement si le support ExtraHop a examiné et approuvé la mise à niveau.

Spécifiez le paramètre body au format JSON suivant.

{
    "firmware_url": "string",
    "force": true,
    "upgrade": true
}

Copier

POST /extrahop/restart

Il n'existe aucun paramètre pour cette opération.

POST /extrahop/shutdown

Il n'existe aucun paramètre pour cette opération.

GET /extrahop/services

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "admin": {
        "enabled": true
    },
    "keyreceiver": {
        "enabled": true
    },
    "snmp": {
        "enabled": true
    },
    "ssh": {
        "enabled": true
    }
}

PATCH /extrahop/services

Spécifiez les paramètres suivants.

body: Objet

Les paramètres des services.

admin: Objet

(Facultatif) Les paramètres du service d'interface graphique de gestion, qui fournit un accès à l'appliance via un navigateur.

enabled: Booléen

Indique si le service est activé.

snmp: Objet

(Facultatif) Les paramètres du service SNMP, qui permettent à votre logiciel de surveillance des équipements réseau de collecter des informations à partir du système ExtraHop.

enabled: Booléen

Indique si le service est activé.

ssh: Objet

(Facultatif) Les paramètres du service SSH, qui permettent aux utilisateurs de se connecter en toute sécurité à l'interface de ligne de commande (CLI) ExtraHop.

enabled: Booléen

Indique si le service est activé.

keyreceiver: Objet

(Facultatif) Les paramètres du récepteur de clés de session SSL, qui permettent à l'appliance de recevoir et de déchiffrer les clés de session depuis le redirecteur de clés de session.

enabled: Booléen

Indique si le service est activé.

Spécifiez le paramètre body au format JSON suivant.

{
    "admin": {
        "enabled": true
    },
    "keyreceiver": {
        "enabled": true
    },
    "snmp": {
        "enabled": true
    },
    "ssh": {
        "enabled": true
    }
}

Copier

GET /extrahop/processes

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "can_restart": true,
    "cpu": 0.0,
    "cpu_time": 0,
    "mem_percent": 0.0,
    "mem_res": 0,
    "mem_virt": 0,
    "process": "string",
    "start_time": 0
}

POST /extrahop/processes/{process}/restart

Spécifiez les paramètres suivants.

process: Corde

Le nom du processus.

Les valeurs suivantes sont valides :

• exadmin
• exalerts
• examf
• exapi
• exbridge
• excap
• exconfig
• exflowlogs
• exsnmpq
• exnotify
• exportal
• exremote
• exsearch
• exstatmirror
• extrend
• webserver
• hopcloud-api

GET /extrahop/cluster

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "ingest_enabled": true,
    "replication_policy": 0
}

PATCH /extrahop/cluster

Spécifiez les paramètres suivants.

body: Objet

Les paramètres de configuration du cluster EXA.

ingest_enabled: Booléen

(Facultatif) Indique si l'ingestion d'enregistrements est activée pour le cluster Explore.

replication_policy: Numéro

(Facultatif) Le niveau de réplication qui détermine le nombre de copies de chaque enregistrement stockées.

Spécifiez le paramètre body au format JSON suivant.

{
    "ingest_enabled": true,
    "replication_policy": 0
}

Copier

GET /extrahop/firmware/previous

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "backup_time": 0,
    "version": "string"
}

POST /extrahop/firmware/previous/rollback

Il n'existe aucun paramètre pour cette opération.

POST /extrahop/cloudresources

Spécifiez les paramètres suivants.

cloudresources: Nom de fichier

Le fichier du bundle de ressources.

GET /extrahop/flowlogs/secret

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "secret": "string"
}

POST /extrahop/flowlogs/secret

Il n'existe aucun paramètre pour cette opération.

GET /extrahop/firmware/next

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

POST /extrahop/firmware/download/version

Spécifiez les paramètres suivants.

body: Objet

(Facultatif) Les options de téléchargement.

version: Corde

Version du microprogramme à télécharger.

upgrade: Booléen

(Facultatif) Spécifie s'il faut mettre à niveau l'appliance une fois le téléchargement du microprogramme terminé.

Spécifiez le paramètre body au format JSON suivant.

{
    "upgrade": true,
    "version": "string"
}

Copier

GET /jobs/{id}

Spécifiez les paramètres suivants.

id: Corde

L'identifiant unique de la tâche.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "details": "string",
    "id": "string",
    "remote_jobs": [],
    "status": "string",
    "step_description": "string",
    "step_number": 0,
    "total_steps": 0,
    "type": "string"
}

GET /jobs

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "details": "string",
    "id": "string",
    "remote_jobs": [],
    "status": "string",
    "step_description": "string",
    "step_number": 0,
    "total_steps": 0,
    "type": "string"
}

PUT /license

Spécifiez les paramètres suivants.

body: Corde

(Facultatif) Le texte de licence qui vous a été fourni par ExtraHop Support, y compris les lignes de début et de fin.

GET /license

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "dossier": "string",
    "edition": "string",
    "expires_at": 0,
    "expires_in": 0,
    "modules": {},
    "options": {},
    "platform": "string",
    "product_key": "string",
    "serial": "string"
}

PUT /license/productkey

Spécifiez les paramètres suivants.

body: Objet

(Facultatif) Appliquez la clé de produit spécifiée à l'appliance.

GET /license/productkey

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "product_key": "string"
}

POST /metrics

Spécifiez les paramètres suivants.

body: Objet

Description de la demande métrique.

from: Numéro

L'horodateur de début de la demande. Renvoie uniquement les statistiques collectées après cette période. Le temps est exprimé en millisecondes depuis l'époque. 0 indique l'heure de la demande. Une valeur négative est évaluée par rapport à l'heure actuelle. L'unité par défaut pour une valeur négative est la milliseconde, mais d'autres unités peuvent être spécifiées avec un suffixe d'unité. Consultez les Guide de l'API REST pour les unités de temps et les suffixes pris en charge.

until: Numéro

L'horodateur de fin de la demande. Renvoie uniquement les statistiques collectées avant cette date. Suit les mêmes directives relatives aux valeurs temporelles que le paramètre from.

cycle: Corde

Période d'agrégation des métriques.

Les valeurs suivantes sont valides :

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

object_type: Corde

Indique le type d'objet des identificateurs uniques spécifiés dans la propriété object_ids.

Les valeurs suivantes sont valides :

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

object_ids: Tableau de nombres

La liste des valeurs numériques qui représentent des identificateurs uniques. Les identifiants uniques peuvent être récupérés via les ressources /networks, /devices, /applications, /vlans, /devicegroups, /activitygroups et /appliances. Pour les mesures de santé du système, spécifiez l'ID de la sonde ou de la console et définissez le paramètre object_type sur « système ».

metric_category: Corde

Groupe de mesures pouvant faire l'objet d'une recherche dans le catalogue de métriques.

metric_specs: Tableau d'objets

Tableau d'objets de spécification métrique.

name: Corde

Le nom du champ pour la métrique. Lors du filtrage dans le catalogue de métriques sur une metric_category, chaque résultat est un nom potentiel de metric_spec. Lorsqu'un résultat est sélectionné dans le catalogue, la valeur du champ « Métrique » est une option valide pour ce champ.

key1: Corde

(Facultatif) Filtrez les mesures détaillées. Les métriques détaillées répartissent les données par clés, qui sont des chaînes ou des adresses IP. Par exemple, la métrique « Requêtes HTTP par méthode » accepte la valeur key1 de « GET ». Les clés peuvent également être des expressions régulières délimitées par des barres obliques (« /GET/ »).

key2: Corde

(Facultatif) Activez un filtrage supplémentaire sur les mesures détaillées.

calc_type: Corde

(Facultatif) Type de calcul à effectuer.

Les valeurs suivantes sont valides :

• mean
• percentiles

percentiles: Tableau de nombres

(Facultatif) La liste des percentiles, triée par ordre croissant, qui doit être renvoyée. Ce paramètre n'est obligatoire que si le paramètre calc_type est défini sur « percentiles ». Si le paramètre calc_type est défini sur mean, la propriété percentiles ne peut pas être définie.

Spécifiez le paramètre body au format JSON suivant.

{
    "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
}

Copier

POST /metrics/total

Spécifiez les paramètres suivants.

body: Objet

Description de la demande métrique.

from: Numéro

L'horodateur de début de la demande. Renvoie uniquement les statistiques collectées après cette période. Le temps est exprimé en millisecondes depuis l'époque. 0 indique l'heure de la demande. Une valeur négative est évaluée par rapport à l'heure actuelle. L'unité par défaut pour une valeur négative est la milliseconde, mais d'autres unités peuvent être spécifiées avec un suffixe d'unité. Consultez les Guide de l'API REST pour les unités de temps et les suffixes pris en charge.

until: Numéro

L'horodateur de fin de la demande. Renvoie uniquement les statistiques collectées avant cette date. Suit les mêmes directives relatives aux valeurs temporelles que le paramètre from.

cycle: Corde

Période d'agrégation des métriques.

Les valeurs suivantes sont valides :

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

object_type: Corde

Indique le type d'objet des identificateurs uniques spécifiés dans la propriété object_ids.

Les valeurs suivantes sont valides :

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

object_ids: Tableau de nombres

La liste des valeurs numériques qui représentent des identificateurs uniques. Les identifiants uniques peuvent être récupérés via les ressources /networks, /devices, /applications, /vlans, /devicegroups, /activitygroups et /appliances. Pour les mesures de santé du système, spécifiez l'ID de la sonde ou de la console et définissez le paramètre object_type sur « système ».

metric_category: Corde

Groupe de mesures pouvant faire l'objet d'une recherche dans le catalogue de métriques.

metric_specs: Tableau d'objets

Tableau d'objets de spécification métrique.

name: Corde

Le nom du champ pour la métrique. Lors du filtrage dans le catalogue de métriques sur une metric_category, chaque résultat est un nom potentiel de metric_spec. Lorsqu'un résultat est sélectionné dans le catalogue, la valeur du champ « Métrique » est une option valide pour ce champ.

key1: Corde

(Facultatif) Filtrez les mesures détaillées. Les métriques détaillées répartissent les données par clés, qui sont des chaînes ou des adresses IP. Par exemple, la métrique « Requêtes HTTP par méthode » accepte la valeur key1 de « GET ». Les clés peuvent également être des expressions régulières délimitées par des barres obliques (« /GET/ »).

key2: Corde

(Facultatif) Activez un filtrage supplémentaire sur les mesures détaillées.

calc_type: Corde

(Facultatif) Type de calcul à effectuer.

Les valeurs suivantes sont valides :

• mean
• percentiles

percentiles: Tableau de nombres

(Facultatif) La liste des percentiles, triée par ordre croissant, qui doit être renvoyée. Ce paramètre n'est obligatoire que si le paramètre calc_type est défini sur « percentiles ». Si le paramètre calc_type est défini sur mean, la propriété percentiles ne peut pas être définie.

Spécifiez le paramètre body au format JSON suivant.

{
    "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
}

Copier

POST /metrics/totalbyobject

Spécifiez les paramètres suivants.

body: Objet

Description de la demande métrique.

from: Numéro

L'horodateur de début de la demande. Renvoie uniquement les statistiques collectées après cette période. Le temps est exprimé en millisecondes depuis l'époque. 0 indique l'heure de la demande. Une valeur négative est évaluée par rapport à l'heure actuelle. L'unité par défaut pour une valeur négative est la milliseconde, mais d'autres unités peuvent être spécifiées avec un suffixe d'unité. Consultez les Guide de l'API REST pour les unités de temps et les suffixes pris en charge.

until: Numéro

L'horodateur de fin de la demande. Renvoie uniquement les statistiques collectées avant cette date. Suit les mêmes directives relatives aux valeurs temporelles que le paramètre from.

cycle: Corde

Période d'agrégation des métriques.

Les valeurs suivantes sont valides :

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

object_type: Corde

Indique le type d'objet des identificateurs uniques spécifiés dans la propriété object_ids.

Les valeurs suivantes sont valides :

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

object_ids: Tableau de nombres

La liste des valeurs numériques qui représentent des identificateurs uniques. Les identifiants uniques peuvent être récupérés via les ressources /networks, /devices, /applications, /vlans, /devicegroups, /activitygroups et /appliances. Pour les mesures de santé du système, spécifiez l'ID de la sonde ou de la console et définissez le paramètre object_type sur « système ».

metric_category: Corde

Groupe de mesures pouvant faire l'objet d'une recherche dans le catalogue de métriques.

metric_specs: Tableau d'objets

Tableau d'objets de spécification métrique.

name: Corde

Le nom du champ pour la métrique. Lors du filtrage dans le catalogue de métriques sur une metric_category, chaque résultat est un nom potentiel de metric_spec. Lorsqu'un résultat est sélectionné dans le catalogue, la valeur du champ « Métrique » est une option valide pour ce champ.

key1: Corde

(Facultatif) Filtrez les mesures détaillées. Les métriques détaillées répartissent les données par clés, qui sont des chaînes ou des adresses IP. Par exemple, la métrique « Requêtes HTTP par méthode » accepte la valeur key1 de « GET ». Les clés peuvent également être des expressions régulières délimitées par des barres obliques (« /GET/ »).

key2: Corde

(Facultatif) Activez un filtrage supplémentaire sur les mesures détaillées.

calc_type: Corde

(Facultatif) Type de calcul à effectuer.

Les valeurs suivantes sont valides :

• mean
• percentiles

percentiles: Tableau de nombres

(Facultatif) La liste des percentiles, triée par ordre croissant, qui doit être renvoyée. Ce paramètre n'est obligatoire que si le paramètre calc_type est défini sur « percentiles ». Si le paramètre calc_type est défini sur mean, la propriété percentiles ne peut pas être définie.

Spécifiez le paramètre body au format JSON suivant.

{
    "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
}

Copier

GET /metrics/next/{xid}

Spécifiez les paramètres suivants.

xid: Numéro

Identifiant unique renvoyé par une requête métrique.

• Appareil
  • actif_depuis
  • actif_jusqu'à
• Groupe d'appareils
  • actif_depuis
  • actif_jusqu'à
• Métriques
  • à partir de
  • jusqu'à
• Journal d'enregistrement
  • à partir de
  • jusqu'à
  • context_ttl

Le tableau suivant indique les unités de temps prises en charge :

Pour spécifier une unité de temps autre que les millisecondes pour un paramètre, ajoutez le suffixe de l'unité à la valeur. Par exemple, pour demander des appareils actifs au cours des 30 dernières minutes, spécifiez la valeur de paramètre suivante :

GET /api/v1/devices?active_from=-30m

L'exemple suivant indique une recherche pour HTTP records créés il y a 1 à 2 heures :

{
    "from": "-2h",
    "until": "-1h",
    "types": ["~http"]
}

GET /networklocalities

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

POST /networklocalities

Spécifiez les paramètres suivants.

body: Objet

Appliquez les valeurs de propriété spécifiées à la nouvelle entrée de localité du réseau.

name: Corde

(Facultatif) Le nom de la localité du réseau. Si ce champ n'est pas spécifié, la localité du réseau est nommée au format suivant : « Locality_ID », où ID est l'identifiant unique de la localité du réseau.

network: Corde

(Facultatif) Obsolète. Spécifiez les blocs CIDR ou les adresses IP dans le champ réseaux.

networks: Tableau de chaînes

(Facultatif) Tableau de blocs CIDR ou d'adresses IP qui définissent la localité du réseau.

external: Booléen

Indique si le réseau est interne ou externe.

description: Corde

(Facultatif) Description facultative de l'entrée de localité du réseau.

Spécifiez le paramètre body au format JSON suivant.

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

Copier

GET /networklocalities/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique pour l'entrée de localité du réseau.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

DELETE /networklocalities/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique pour l'entrée de localité du réseau.

PATCH /networklocalities/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour des valeurs de propriété spécifiées à l'entrée de localité du réseau.

network: Corde

(Facultatif) Obsolète. Spécifiez les blocs CIDR ou les adresses IP dans le champ réseaux.

networks: Tableau de chaînes

(Facultatif) Tableau de blocs CIDR ou d'adresses IP qui définissent la localité du réseau.

name: Corde

(Facultatif) Le nom de la localité du réseau.

external: Booléen

(Facultatif) Indique si le réseau est interne ou externe.

description: Corde

(Facultatif) Description facultative de l'entrée de localité du réseau.

Spécifiez le paramètre body au format JSON suivant.

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

Copier

id: Numéro

Identifiant unique pour l'entrée de localité du réseau.

GET /nodes

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "add_time": 0,
    "display_name": "string",
    "enabled": true,
    "firmware_version": "string",
    "hostname": "string",
    "id": 0,
    "license_status": "string",
    "nickname": "string",
    "ntp_sync": true,
    "product_key": "string",
    "status_code": "string",
    "status_message": "string",
    "time_added": 0,
    "time_offset": 0,
    "uuid": "string"
}

GET /nodes/{id}

Spécifiez les paramètres suivants.

id: Numéro

ID de la sonde.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "add_time": 0,
    "display_name": "string",
    "enabled": true,
    "firmware_version": "string",
    "hostname": "string",
    "id": 0,
    "license_status": "string",
    "nickname": "string",
    "ntp_sync": true,
    "product_key": "string",
    "status_code": "string",
    "status_message": "string",
    "time_added": 0,
    "time_offset": 0,
    "uuid": "string"
}

PATCH /nodes/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour spécifiées au nœud Discover.

id: Numéro

Identifiant unique du nœud Discover.

GET /odstargets

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{}

GET /odstargets/http

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{}

GET /odstargets/http/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{}

GET /odstargets/kafka

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "brokers": [],
    "compression": "string",
    "name": "string",
    "partition_strategy": "string",
    "protocol": "string",
    "skip_cert_verification": true,
    "tls_ca_certs": "string",
    "tls_client_cert": "string",
    "tls_client_key": "string"
}

GET /odstargets/kafka/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "brokers": [],
    "compression": "string",
    "name": "string",
    "partition_strategy": "string",
    "protocol": "string",
    "skip_cert_verification": true,
    "tls_ca_certs": "string",
    "tls_client_cert": "string",
    "tls_client_key": "string"
}

GET /odstargets/mongodb

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{}

GET /odstargets/mongodb/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{}

GET /odstargets/raw

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{}

GET /odstargets/raw/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{}

GET /odstargets/syslog

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "batch_min_bytes": 0,
    "concurrent_connections": 0,
    "host": "string",
    "localtime": true,
    "name": "string",
    "port": 0,
    "protocol": "string",
    "skip_cert_verification": true,
    "tcp_length_prefix_framing": true,
    "tls_ca_certs": "string",
    "tls_client_cert": "string",
    "tls_client_key": "string"
}

GET /odstargets/syslog/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "batch_min_bytes": 0,
    "concurrent_connections": 0,
    "host": "string",
    "localtime": true,
    "name": "string",
    "port": 0,
    "protocol": "string",
    "skip_cert_verification": true,
    "tcp_length_prefix_framing": true,
    "tls_ca_certs": "string",
    "tls_client_cert": "string",
    "tls_client_key": "string"
}

POST /odstargets/http

Spécifiez les paramètres suivants.

body: Objet

name: Corde

Le nom de la cible.

host: Corde

Le nom d'hôte ou l'adresse IP du serveur HTTP distant.

port: Numéro

Numéro de port TCP du serveur HTTP.

protocol: Corde

Le protocole de transmission des données.

Les valeurs suivantes sont valides :

• http
• https

skip_cert_verification: Booléen

(Facultatif) Indique s'il faut contourner la vérification du certificat TLS pour les données chiffrées. Ce paramètre n'est valide que si le protocole est défini sur https.

pipeline: Booléen

Indique si plusieurs connexions HTTP simultanées sont activées, ce qui peut améliorer la vitesse de débit.

additional_header: Corde

(Facultatif) Spécifie un en-tête HTTP supplémentaire à inclure dans chaque demande. Les en-têtes doivent être spécifiés au format suivant : "<key>: <value>». Par exemple : « additional_header » : « Accept : text/html ».

authentication: Objet

Objet contenant des identifiants d'authentification HTTP.

auth_type: Corde

Type d'authentification HTTP.

Les valeurs suivantes sont valides :

• none
• basic
• aws
• azure_storage
• azure_ad
• crowdstrike

username: Corde

(Facultatif) Le nom de l'utilisateur. Cette option est obligatoire si auth_type est défini sur basic ou si auth_type est défini sur azure_ad et grant_type est défini sur resource_owner.

password: Corde

(Facultatif) Le mot de passe de l'utilisateur. Cette option est obligatoire si auth_type est défini sur basic ou si auth_type est défini sur azure_ad et grant_type est défini sur resource_owner.

access_key: Corde

(Facultatif) L'ID de la clé d'accès. Cette option est requise pour l'authentification entre AWS et Azure Storage.

secret_key: Corde

(Facultatif) La clé d'accès secrète. Cette option est requise pour l'authentification AWS.

service: Corde

(Facultatif) Le code de service du service AWS, tel que « AmazonEC2 ». Cette option est requise pour l'authentification AWS.

region: Corde

(Facultatif) Le nom de la région AWS, par exemple « us-west-1 ». Cette option est requise pour l'authentification AWS.

grant_type: Corde

(Facultatif) Type d'autorisation OAuth 2.0. Cette option est requise pour l'authentification par identifiant Microsoft Entra.

Les valeurs suivantes sont valides :

• client
• resource_owner

client_id: Corde

(Facultatif) L'ID du client. Cette option est requise pour l'authentification Microsoft Entra ID et Crowdstrike.

client_secret: Corde

(Facultatif) La clé secrète du client. Cette option est requise pour l'authentification Microsoft Entra ID et Crowdstrike.

resource: Corde

(Facultatif) L'URI de la ressource Microsoft Entra ID. Cette option est requise pour l'authentification par identifiant Microsoft Entra.

token_endpoint: Corde

(Facultatif) Le point de terminaison Microsoft Entra ID /token. Par exemple : « https://login.microsoftonline.com/ <tenant_id>/oauth2/token ». Cette option est requise pour l'authentification par identifiant Microsoft Entra.

Spécifiez le paramètre body au format JSON suivant.

{
    "additional_header": "string",
    "authentication": {
        "auth_type": "string",
        "username": "string",
        "password": "string",
        "access_key": "string",
        "secret_key": "string",
        "service": "string",
        "region": "string",
        "grant_type": "string",
        "client_id": "string",
        "client_secret": "string",
        "resource": "string",
        "token_endpoint": "string"
    },
    "host": "string",
    "name": "string",
    "pipeline": true,
    "port": 0,
    "protocol": "string",
    "skip_cert_verification": true
}

Copier

POST /odstargets/kafka

Spécifiez les paramètres suivants.

body: Objet

name: Corde

Le nom de la cible.

brokers: Tableau d'objets

Tableau d'un ou de plusieurs objets contenant des informations sur Kafka Brokers.

host: Corde

Le nom d'hôte ou l'adresse IP du broker Kafka distant.

port: Numéro

Le numéro de port TCP du broker Kafka.

compression: Corde

(Facultatif) Méthode de compression à appliquer aux données transmises.

Les valeurs suivantes sont valides :

• none
• gzip
• snappy

partition_strategy: Corde

(Facultatif) Méthode de partitionnement à appliquer aux données transmises.

Les valeurs suivantes sont valides :

• hash_key
• manual
• random
• round_robin

protocol: Corde

Le protocole de transmission des données.

Les valeurs suivantes sont valides :

• tcp
• tls

tls_client_cert: Corde

(Facultatif) Le certificat client TLS qui est envoyé au serveur Kafka lors de l'établissement dproximation TLS. Spécifiez cette option si l'authentification du client est activée sur le serveur Kafka.

tls_client_key: Corde

(Facultatif) La clé privée du certificat client TLS spécifiée par le paramètre tls_client_cert. Spécifiez cette option si l'authentification du client est activée sur le serveur Kafka.

skip_cert_verification: Booléen

(Facultatif) Indique s'il faut contourner la vérification du certificat TLS pour les données chiffrées. Ce paramètre n'est valide que si le protocole est défini sur tls.

tls_ca_certs: Corde

(Facultatif) Les certificats sécurisés avec lesquels valider le certificat du serveur Kafka, au format PEM. Spécifiez cette option si le certificat de votre serveur Kafka n'a pas été signé par une autorité de certification (CA) valide. Si cette option n'est pas spécifiée, le certificat de serveur est validé à l'aide de la liste intégrée des certificats CA valides. Cette option n'est valide que si le protocole est TLS.

authentication: Objet

(Facultatif) Objet contenant les identifiants d'authentification Kafka.

auth_type: Corde

Type d'authentification SASL.

Les valeurs suivantes sont valides :

• scram

username: Corde

Le nom d'utilisateur de l'utilisateur SASL.

password: Corde

Le mot de passe de l'utilisateur SASL.

algorithm: Corde

Algorithme de hachage pour l'authentification SASL.

Les valeurs suivantes sont valides :

• sha256
• sha512

Spécifiez le paramètre body au format JSON suivant.

{
    "authentication": {
        "auth_type": "string",
        "username": "string",
        "password": "string",
        "algorithm": "string"
    },
    "brokers": {
        "host": "string",
        "port": 0
    },
    "compression": "string",
    "name": "string",
    "partition_strategy": "string",
    "protocol": "string",
    "skip_cert_verification": true,
    "tls_ca_certs": "string",
    "tls_client_cert": "string",
    "tls_client_key": "string"
}

Copier

POST /odstargets/mongodb

Spécifiez les paramètres suivants.

body: Objet

name: Corde

Le nom de la cible.

host: Corde

Le nom d'hôte ou l'adresse IP du serveur MongoDB distant.

port: Numéro

Numéro de port TCP du serveur MongoDB.

encrypt: Booléen

(Facultatif) Indique si les données sont chiffrées avec le protocole TLS.

skip_cert_verification: Booléen

(Facultatif) Indique s'il faut contourner la vérification du certificat TLS pour les données chiffrées. Ce paramètre n'est valide que si « encryption » est défini sur « true ».

authentication: Tableau d'objets

(Facultatif) Tableau d'objets contenant les identifiants d'authentification MongoDB.

database: Corde

Nom de la base de données MongoDB.

user: Corde

Le nom de l'utilisateur autorisé à modifier la base de données spécifiée.

password: Corde

Le mot de passe de l'utilisateur.

Spécifiez le paramètre body au format JSON suivant.

{
    "authentication": {
        "database": "string",
        "user": "string",
        "password": "string"
    },
    "encrypt": true,
    "host": "string",
    "name": "string",
    "port": 0,
    "skip_cert_verification": true
}

Copier

POST /odstargets/raw

Spécifiez les paramètres suivants.

body: Objet

name: Corde

Le nom de la cible.

host: Corde

Le nom d'hôte ou l'adresse IP du serveur distant.

port: Numéro

Numéro de port TCP ou UDP du serveur distant.

protocol: Corde

Le protocole de transmission des données.

Les valeurs suivantes sont valides :

• tcp
• udp

compression: Booléen

(Facultatif) Indique si la compression gzip est appliquée aux données transmises.

gzip_threshold_bytes: Numéro

(Facultatif) Le nombre d'octets qui spécifie le seuil de création d'un nouveau message. Toutes les 30 secondes, la sonde ou la console envoie des messages dont la taille dépasse la taille spécifiée pour éviter que les messages ne deviennent trop volumineux. Cette option n'est valide que si la compression est définie sur true.

gzip_threshold_seconds: Numéro

(Facultatif) Le nombre de secondes qui spécifie le seuil de création d'un nouveau message. Toutes les 30 secondes, la sonde ou la console envoie des messages qui ont été écrits pendant une durée supérieure à la période spécifiée afin d'éviter que les messages ne deviennent trop volumineux. Cette option n'est valide que si la compression est définie sur true.

Spécifiez le paramètre body au format JSON suivant.

{
    "compression": true,
    "gzip_threshold_bytes": 0,
    "gzip_threshold_seconds": 0,
    "host": "string",
    "name": "string",
    "port": 0,
    "protocol": "string"
}

Copier

POST /odstargets/syslog

Spécifiez les paramètres suivants.

body: Objet

name: Corde

Le nom de la cible.

host: Corde

Le nom d'hôte ou l'adresse IP du serveur Syslog distant.

port: Numéro

Numéro de port TCP ou UDP du serveur Syslog distant.

tcp_length_prefix_framing: Booléen

(Facultatif) Indique s'il faut ajouter le nombre d'octets d'un message au début du message. Si ce paramètre est défini sur faux, la fin de chaque message est délimitée par une nouvelle ligne de fin.

batch_min_bytes: Numéro

(Facultatif) Le nombre minimum d'octets à envoyer simultanément au serveur Syslog.

concurrent_connections: Numéro

(Facultatif) Le nombre de connexions simultanées sur lesquelles envoyer des messages.

localtime: Booléen

(Facultatif) Indique si les horodatages font référence au fuseau horaire local de la sonde ou de la console. Si ce paramètre est défini sur faux, les horodatages font référence à GMT.

protocol: Corde

Le protocole de transmission des données.

Les valeurs suivantes sont valides :

• tcp
• udp
• tls

tls_client_cert: Corde

(Facultatif) Le certificat client TLS qui est envoyé au serveur Syslog lors de l'établissement dproximation TLS. Spécifiez cette option si l'authentification du client est activée sur le serveur Syslog.

tls_client_key: Corde

(Facultatif) La clé privée du certificat client TLS spécifiée par le paramètre tls_client_cert. Spécifiez cette option si l'authentification du client est activée sur le serveur Syslog.

skip_cert_verification: Booléen

(Facultatif) Indique s'il faut contourner la vérification du certificat TLS pour les données chiffrées. Ce paramètre n'est valide que si le protocole est défini sur tls.

tls_ca_certs: Corde

(Facultatif) Les certificats sécurisés avec lesquels valider le certificat du serveur Syslog, au format PEM. Spécifiez cette option si le certificat de votre serveur Syslog n'a pas été signé par une autorité de certification (CA) valide. Si cette option n'est pas spécifiée, le certificat de serveur est validé à l'aide de la liste intégrée des certificats CA valides. Cette option n'est valide que si le protocole est TLS et que skip_cert_verification est faux.

Spécifiez le paramètre body au format JSON suivant.

{
    "batch_min_bytes": 0,
    "concurrent_connections": 0,
    "host": "string",
    "localtime": true,
    "name": "string",
    "port": 0,
    "protocol": "string",
    "skip_cert_verification": true,
    "tcp_length_prefix_framing": true,
    "tls_ca_certs": "string",
    "tls_client_cert": "string",
    "tls_client_key": "string"
}

Copier

DELETE /odstargets/http/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

DELETE /odstargets/kafka/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

DELETE /odstargets/mongodb/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

DELETE /odstargets/raw/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

DELETE /odstargets/syslog/{name}

Spécifiez les paramètres suivants.

name: Corde

Le nom de la cible.

POST /pairing/token

Il n'existe aucun paramètre pour cette opération.

POST /records/search

Spécifiez les paramètres suivants.

body: Objet

Requête du journal d'enregistrement.

from: Numéro

L'horodateur de début de la plage de temps recherchée par la requête, exprimé en millisecondes depuis l'époque. Une valeur négative indique que la recherche débutera avec les enregistrements créés à un moment donné dans le passé. Par exemple, spécifiez -600 000 ms pour commencer la recherche avec les enregistrements créés 10 minutes avant l'heure de la demande. Les valeurs négatives peuvent être spécifiées avec une unité de temps autre que les millisecondes, telle que les secondes ou les heures. Consultez les Guide de l'API REST pour les unités de temps et les suffixes pris en charge.

until: Numéro

L'horodateur de fin de la plage de temps recherchée par la requête, exprimé en millisecondes depuis l'époque. Une valeur 0 indique que la recherche se terminera par les enregistrements créés au moment de la demande. Une valeur négative indique que la recherche se terminera par des enregistrements créés dans le passé. Par exemple, spécifiez -300 000 ms pour terminer la recherche avec les enregistrements créés 5 minutes avant l'heure de la demande. Les valeurs négatives peuvent être spécifiées avec une unité de temps autre que les millisecondes, telle que les secondes ou les heures. Consultez les Guide de l'API REST pour les unités de temps et les suffixes pris en charge.

types: Tableau de cordes

(Facultatif) Tableau d'un ou de plusieurs formats d'enregistrement. La requête renvoie uniquement les enregistrements correspondant aux formats spécifiés. Si aucune valeur n'est spécifiée, la requête renvoie des enregistrements de n'importe quel type. Les valeurs valides pour ce champ sont affichées dans le champ Type d'enregistrement de la page Formats d'enregistrement. Par exemple : « ~cifs ».

limit: Numéro

Le nombre maximum d'enregistrements renvoyés par la requête. La valeur maximale ne peut pas dépasser 10 000. La valeur par défaut est 100.

offset: Numéro

Le nombre d'enregistrements à ignorer dans les résultats de la requête. La requête renverra des enregistrements à partir de la valeur de décalage. Ce paramètre est souvent associé aux paramètres de limite et de tri. La valeur par défaut est 0. Pour les magasins d'enregistrements ExtraHop, la valeur maximale est de 10 000 ; pour récupérer les enregistrements renvoyés après les 10 000 premiers, consultez POST /records/cursor/. Pour les magasins de disques tiers, il n'y a pas de valeur maximale.

sort: Tableau d'objets

Liste d'un ou de plusieurs objets de tri qui spécifient les priorités de tri. Les enregistrements renvoyés sont triés dans l'ordre dans lequel les objets sont répertoriés. Les paramètres sont définis dans la section sort_item ci-dessous. Si aucune valeur sort_item n'est fournie, les enregistrements sont triés par horodateur dans l'ordre décroissant.

field: Corde

Le nom du champ qui a renvoyé les enregistrements est trié par.

direction: Corde

L'ordre dans lequel les enregistrements renvoyés sont triés. L'ordre par défaut est décroissant. Une fois tous les autres critères de tri appliqués, ou si aucun critère de tri n'a été spécifié, l'ordre par défaut est décroissant par horodateur.

Les valeurs suivantes sont valides :

• asc
• desc

filter: Objet

L'objet contenant les paramètres qui spécifient les critères de filtre. Les paramètres sont définis dans la section des filtres ci-dessous. Si aucune valeur de filtre n'est fournie, la requête renvoie tous les enregistrements correspondant à l'intervalle de temps et à tout format d'enregistrement spécifié.

field: Corde

Le nom du champ de l'enregistrement à filtrer. La requête compare le contenu du paramètre de champ à la valeur du paramètre d'opérande. Si le nom de champ spécifié est « .any », l'union de toutes les valeurs de champ sera recherchée. Si le nom de champ spécifié est « .ipaddr » ou « .port », les rôles client, serveur, expéditeur et destinataire sont inclus dans la recherche. Les noms des champs sont situés dans des formats d'enregistrement qui peuvent être visualisés dans le système ExtraHop.

operator: Corde

Méthode de comparaison appliquée lors de la mise en correspondance de la valeur de l'opérande avec le contenu du champ. Tous les objets filtrants nécessitent un opérateur.

Les valeurs suivantes sont valides :

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

operand: Chaîne, numéro ou objet

La valeur à laquelle la requête tente de faire correspondre. La requête compare la valeur de l'opérande au contenu du paramètre de champ et applique la méthode de comparaison spécifiée par le paramètre de l'opérateur. Vous pouvez spécifier explicitement le type de données de l'opérande comme décrit dans le Guide de l'API REST.

rules: Tableau d'objets

Liste d'un ou de plusieurs objets filtrants au sein d'un même objet filtrant. Les objets de filtre peuvent être incorporés de manière récursive. Seuls les opérateurs « et », « ou » et « non » sont autorisés pour ce paramètre.

context_ttl: Numéro

Durée pendant laquelle le contexte de recherche reste actif. La valeur spécifiée est interprétée comme une durée dans le futur. L'unité par défaut est la milliseconde, mais d'autres unités peuvent être spécifiées avec un suffixe d'unité. Consultez les Guide de l'API REST pour les unités de temps et les suffixes pris en charge. Si une valeur non nulle est spécifiée, la réponse inclut un identifiant de curseur accepté par POST /records/cursor/. Ce paramètre n'est pas pris en charge pour les magasins d'enregistrement tiers.

Spécifiez le paramètre body au format JSON suivant.

{
    "context_ttl": 0,
    "filter": {
        "field": "string",
        "operator": "string",
        "operand": "string",
        "rules": []
    },
    "from": 0,
    "limit": 0,
    "offset": 0,
    "sort": {
        "field": "string",
        "direction": "string"
    },
    "types": [],
    "until": 0
}

Copier

POST /records/cursor

Spécifiez les paramètres suivants.

body: Objet

L'ID du curseur qui indique la page suivante de résultats de la requête.

cursor: Corde

Identifiant unique du curseur qui indique la page de résultats suivante de la requête.

Spécifiez le paramètre body au format JSON suivant.

{
    "cursor": "string"
}

Copier

context_ttl: Numéro

(Facultatif) Durée pendant laquelle le contexte de recherche reste actif, exprimée en millisecondes.

GET /records/cursor/{cursor}

Spécifiez les paramètres suivants.

cursor: Corde

L'ID du curseur.

context_ttl: Numéro

(Facultatif) Durée pendant laquelle le contexte de recherche reste actif, exprimée en millisecondes.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "cursor": "string",
    "from": 0,
    "records": {},
    "total": 0,
    "until": 0,
    "warnings": {}
}

L'exemple suivant spécifie explicitement le type de données et la valeur de l' opérande :

{
    "from": -1000,
    "filter": {
        "field" : "senderAddr",
        "operator": "=",
        "operand" : { "type" : "ipaddr4", "value": "1.2.3.4" }
    }
}

L'exemple suivant indique uniquement la valeur de l' opérande :

{
    "from": -1000,
    "filter": {
        "field" : "senderAddr",
        "operator": "=",
        "operand" : "1.2.3.4"
    }
}

Vous pouvez spécifier explicitement les types de données suivants dans le operand champ :

• application
• booléen
• équipement

  Remarque :

  Vous devez spécifier l'ID de découverte de l'équipement dans le champ de valeur. Vous pouvez trouver l'identifiant de découverte d'un équipement via le POST /devices/search opération.

• filtre_appareil
• groupe_d'appareils
• interface de flux
• réseau de flux
• ipad dr4
• ipad dr6
• nombre
• localité_réseau
• objet
• chaîne

Le operand le champ prend en charge la notation CIDR lors du filtrage par adresse IP ; le operator le champ doit être défini sur « = » ou « ! = ».

{
  "filter": {
    "operator": "and",
    "rules": [
      {
        "field": "method",
        "operand": "SMB2_READ",
        "operator": "="
      },
      {
        "field": "reqL2Bytes",
        "operand": "100",
        "operator": ">"
      }
    ]
  },
  "types": [
    "~cifs"
  ],
    "from": "-30m"
}

• Appareil
  • actif_depuis
  • actif_jusqu'à
• Groupe d'appareils
  • actif_depuis
  • actif_jusqu'à
• Métriques
  • à partir de
  • jusqu'à
• Journal d'enregistrement
  • à partir de
  • jusqu'à
  • context_ttl

Le tableau suivant indique les unités de temps prises en charge :

Pour spécifier une unité de temps autre que les millisecondes pour un paramètre, ajoutez le suffixe de l'unité à la valeur. Par exemple, pour demander des appareils actifs au cours des 30 dernières minutes, spécifiez la valeur de paramètre suivante :

GET /api/v1/devices?active_from=-30m

L'exemple suivant indique une recherche pour HTTP records créés il y a 1 à 2 heures :

{
    "from": "-2h",
    "until": "-1h",
    "types": ["~http"]
}

GET /runningconfig/saved

Il n'existe aucun paramètre pour cette opération.

POST /runningconfig/save

Il n'existe aucun paramètre pour cette opération.

GET /runningconfig

Spécifiez les paramètres suivants.

section: Corde

(Facultatif) (Facultatif) Section spécifique du fichier de configuration en cours d'exécution que vous souhaitez récupérer.

PUT /runningconfig

Spécifiez les paramètres suivants.

body: Corde

(Facultatif) Le fichier de configuration en cours d'exécution.

GET /ssldecryptkeys

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

POST /ssldecryptkeys

Spécifiez les paramètres suivants.

body: Objet

Définissez les valeurs de propriété spécifiées sur la nouvelle clé de déchiffrement SSL.

enabled: Booléen

Indiquez si cette clé de déchiffrement SSL est active.

name: Corde

Nom convivial de la clé de déchiffrement SSL.

certificate: Corde

Le certificat SSL associé à cette clé de déchiffrement.

private_key: Corde

La clé privée SSL qui déchiffre le trafic.

Spécifiez le paramètre body au format JSON suivant.

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

Copier

PATCH /ssldecryptkeys/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour de propriétés spécifiées à la clé de déchiffrement SSL.

id: Corde

Représentation hexadécimale du hachage SHA-1 de la clé de déchiffrement SSL. La chaîne ne doit pas inclure de délimiteurs.

GET /ssldecryptkeys/{id}

Spécifiez les paramètres suivants.

id: Corde

Représentation hexadécimale du hachage SHA-1 de la clé de déchiffrement SSL. La chaîne ne doit pas inclure de délimiteurs.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

DELETE /ssldecryptkeys/{id}

Spécifiez les paramètres suivants.

id: Corde

Représentation hexadécimale du hachage SHA-1 de la clé de déchiffrement SSL. La chaîne ne doit pas inclure de délimiteurs.

GET /ssldecryptkeys/{id}/protocols

Spécifiez les paramètres suivants.

id: Corde

Représentation hexadécimale du hachage SHA-1 de la clé de déchiffrement SSL. La chaîne ne doit pas inclure de délimiteurs.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "port": 0,
    "protocol": "string"
}

POST /ssldecryptkeys/{id}/protocols

Spécifiez les paramètres suivants.

body: Objet

Le corps du protocole.

protocol: Corde

Le nom du protocole, en minuscules.

port: Numéro

Port dans lequel écouter le trafic.

Spécifiez le paramètre body au format JSON suivant.

{
    "port": 0,
    "protocol": "string"
}

Copier

id: Corde

Identifiant unique de la clé de déchiffrement SSL.

DELETE /ssldecryptkeys/{id}/protocols/{protocol}

Spécifiez les paramètres suivants.

protocol: Corde

Le nom du protocole, en minuscules.

id: Corde

Représentation hexadécimale du hachage SHA-1 de la clé de déchiffrement SSL. La chaîne ne doit pas inclure de délimiteurs.

port: Numéro

(Facultatif) Supprimez uniquement les protocoles assignés sur ce port.

GET /supportpacks/queue/{id}

Spécifiez les paramètres suivants.

id: Corde

Identifiant unique du pack de support en cours d'exécution.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "created_time": 0,
    "filename": "string",
    "size": "string"
}

GET /supportpacks/{filename}

Spécifiez les paramètres suivants.

filename: Corde

Nom du pack de support à télécharger.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "created_time": 0,
    "filename": "string",
    "size": "string"
}

POST /supportpacks/execute

GET /supportpacks

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "created_time": 0,
    "filename": "string",
    "size": "string"
}

POST /supportpacks

Spécifiez les paramètres suivants.

file: Nom du fichier

Nom du fichier du pack de support.

GET /tags

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

POST /tags

Spécifiez les paramètres suivants.

body: Objet

Appliquez les valeurs de propriété spécifiées à la nouvelle balise.

name: Corde

La valeur de chaîne de la balise.

Spécifiez le paramètre body au format JSON suivant.

{
    "name": "string"
}

Copier

GET /tags/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de la balise.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

DELETE /tags/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de la balise.

PATCH /tags/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour des valeurs de propriété spécifiées à la balise.

id: Numéro

Identifiant unique de la balise.

GET /tags/{id}/devices

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de la balise.

POST /tags/{id}/devices

Spécifiez les paramètres suivants.

body: Objet

Listes d'identifiants uniques que l'équipement doit attribuer ou non.

assign: Tableau de nombres

Identifiants des ressources à attribuer

unassign: Tableau de nombres

Identifiants des ressources à annuler

Spécifiez le paramètre body au format JSON suivant.

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

Copier

id: Numéro

Identifiant unique de la balise.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'équipement.

id: Numéro

l'identifiant unique du tag.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'équipement.

id: Numéro

Identifiant unique de la balise.

GET /usergroups

Il n'existe aucun paramètre pour cette opération.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

POST /usergroups

Spécifiez les paramètres suivants.

body: Objet

Les propriétés du groupe d'utilisateurs.

name: Corde

Le nom du groupe d'utilisateurs.

enabled: Booléen

Indique si le groupe d'utilisateurs est activé.

Spécifiez le paramètre body au format JSON suivant.

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

Copier

PATCH /usergroups/{id}

Spécifiez les paramètres suivants.

body: Objet

La valeur de la propriété est mise à jour pour le groupe d'utilisateurs spécifique.

id: Corde

Identifiant unique du groupe d'utilisateurs.

GET /usergroups/{id}

Spécifiez les paramètres suivants.

id: Corde

Identifiant unique du groupe d'utilisateurs.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

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

DELETE /usergroups/{id}

Spécifiez les paramètres suivants.

id: Corde

Identifiant unique du groupe d'utilisateurs.

DELETE /usergroups/{id}/associations

Spécifiez les paramètres suivants.

id: Corde

Identifiant unique du groupe d'utilisateurs.

GET /usergroups/{id}/members

Spécifiez les paramètres suivants.

id: Corde

Identifiant unique du groupe d'utilisateurs.

Si la demande aboutit, le système ExtraHop renvoie un objet au format suivant.

{
    "users": {}
}

POST /usergroups/refresh

Il n'existe aucun paramètre pour cette opération.

POST /usergroups/{id}/refresh

Spécifiez les paramètres suivants.

id: Corde

Identifiant unique du groupe d'utilisateurs.

PATCH /usergroups/{id}/members

Spécifiez les paramètres suivants.

id: Corde

Identifiant unique du groupe d'utilisateurs.

body: Corde

Objet qui spécifie les utilisateurs à affecter ou à annuler. Chaque clé doit être un nom d'utilisateur et chaque valeur doit être « membre » ou nulle. Par exemple, {"Alice » : « member », « Bob » : null} assigne Alice au groupe et retire Bob du groupe.

PUT /usergroups/{id}/members

Spécifiez les paramètres suivants.

id: Corde

Identifiant unique du groupe d'utilisateurs.

body: Corde

Objet qui spécifie quels utilisateurs sont affectés au groupe. Chaque clé doit être un nom d'utilisateur et chaque valeur doit être « membre ». Par exemple, {"Alice » : « member », « Bob » : « member"} désigne Alice et Bob comme seuls membres du groupe.