Guide de l'API REST ExtraHop

POST /activitymaps

Spécifiez les paramètres suivants.

body: Objet

Les propriétés de la carte dactivities.

name: Corde

Nom convivial de la carte dactivités.

short_code: Corde

(Facultatif) Le code abrégé unique qui est global à toutes les cartes d'activités.

description: Corde

Description de la carte dactivitiés.

weighting: Corde

(Facultatif) La valeur métrique qui détermine la pondération de l'activité entre les appareils. Les valeurs d'élément prises en charge sont « bytes », « connections » et « turns ».

mode: Corde

(Facultatif) La mise en page de la carte dactivités. Les valeurs prises en charge sont « 2dforce » et « 3dforce ».

show_alert_status: Booléen

(Facultatif) Indique s'il faut afficher l'état d'alerte des appareils sur la carte dactivités. Si cette option est activée, la couleur de chaque équipement sur la carte représente le niveau d'alerte le plus grave associé à l'équipement.

walks: Tableau d'objets

La liste d'un ou de plusieurs objets de promenade. Une promenade est le chemin de circulation composé d'une ou de plusieurs marches. Chaque étape commence par un ou plusieurs appareils d'origine et s'étend aux connexions aux appareils homologues basées sur l'activité du protocole. Chaque extension depuis l'origine est une étape. Le contenu de l'objet est défini dans la section « promenade » ci-dessous.

origins: Tableau d'objets

La liste d'un ou de plusieurs appareils d'origine de la première étape de la promenade. Le contenu de l'objet est défini dans la section « source_object » ci-dessous.

object_type: Corde

Type de source métrique.

Les valeurs suivantes sont valides :

• device
• device_group

object_id: Numéro

Identifiant unique de l'objet source.

steps: Tableau d'objets

La liste d'une ou de plusieurs étapes de la promenade. Chaque étape est définie par l'activité du protocole entre les appareils de l'étape précédente et un nouvel ensemble de périphériques homologues. Le contenu de l'objet est défini dans la section « étape » ci-dessous.

relationships: Tableau d'objets

(Facultatif) Liste d'un ou de plusieurs filtres qui définissent la relation entre deux appareils. Les filtres spécifient les rôles et les protocoles à rechercher lors de la localisation des appareils homologues au cours de l'étape. Les relations sont représentées sous forme d'arête sur la carte dactivités. Le contenu de l'objet est défini dans la section « relation » ci-dessous. Si aucune valeur n'est spécifiée, l'opération localisera tous les homologues.

protocol: Corde

(Facultatif) Le protocole métrique associé à la relation, tel que « HTTP » ou « DNS ». L'opération localise uniquement les connexions entre les appareils via le protocole spécifié.

role: Corde

(Facultatif) Rôle d'équipement associé au protocole métrique de la relation. L'opération localise uniquement les connexions entre les appareils via le protocole associé dans le rôle spécifié. Les valeurs de rôle prises en charge sont « client », « serveur » ou « quelconque ». Définissez sur « any » pour localiser toutes les relations client, serveur et équipement homologue associées au protocole spécifié.

peer_in: Tableau d'objets

(Facultatif) Liste d'un ou de plusieurs objets d'équipement homologues à inclure dans la carte dactivités. Seules les relations avec les homologues de l'objet source spécifié sont incluses. Le contenu de l'objet est défini dans la section « source_object » ci-dessous.

object_type: Corde

Type de source métrique.

Les valeurs suivantes sont valides :

• device
• device_group

object_id: Numéro

Identifiant unique de l'objet source.

peer_not_in: Tableau d'objets

(Facultatif) Liste d'un ou de plusieurs objets d'équipement homologues à exclure de la carte dactivités. Les relations avec les homologues de l'objet source spécifié sont exclues. Le contenu de l'objet est défini dans la section « source_object » ci-dessous.

object_type: Corde

Type de source métrique.

Les valeurs suivantes sont valides :

• device
• device_group

object_id: Numéro

Identifiant unique de l'objet source.

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

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

Copier

POST /activitymaps/query

Spécifiez les paramètres suivants.

body: Objet

Les propriétés de la requête topologique.

from: Numéro

L'horodateur de début de la plage temporelle recherchée par la requête, exprimé en millisecondes depuis l'époque.

until: Numéro

(Facultatif) L'horodateur de fin de la plage de temps recherchée par la requête, exprimé en millisecondes depuis l'époque. Si aucune valeur n'est définie, la fin de la requête est par défaut « maintenant ».

weighting: Corde

(Facultatif) La valeur métrique qui détermine la pondération de l'activité entre les appareils.

Les valeurs suivantes sont valides :

• bytes
• connections
• turns

edge_annotations: Tableau de chaînes

(Facultatif) La liste d'une ou plusieurs annotations de bord à inclure dans la requête topologique.

Les valeurs suivantes sont valides :

• protocols
• appearances

walks: Tableau d'objets

Liste d'un ou de plusieurs objets de promenade à inclure dans la requête topologique. Une promenade est le chemin de circulation composé d'une ou de plusieurs marches. Chaque étape commence par un ou plusieurs appareils d'origine et s'étend aux connexions aux appareils homologues basées sur l'activité du protocole. Chaque extension depuis l'origine est une étape. Le contenu de l'objet est défini dans la section « topology_walk » ci-dessous.

origins: Tableau d'objets

La liste d'un ou de plusieurs appareils d'origine de la première étape de la promenade. Le contenu de l'objet est défini dans la section « topology_source » ci-dessous.

object_type: Corde

Type d'objet source.

Les valeurs suivantes sont valides :

• all_devices
• device_group
• device

object_id: Numéro

Identifiant unique de l'objet source. Défini sur 0 si la valeur du paramètre « object_type » est « all_devices ».

steps: Tableau d'objets

La liste d'une ou de plusieurs étapes de la promenade. Chaque étape est définie par l'activité du protocole entre les appareils de l'étape précédente et un nouvel ensemble de périphériques homologues. Le contenu de l'objet est défini dans la section « topology_step » ci-dessous.

relationships: Tableau d'objets

(Facultatif) Liste d'un ou de plusieurs filtres qui définissent la relation entre deux appareils. Les filtres spécifient les rôles et les protocoles à rechercher lors de la localisation des appareils homologues au cours de l'étape. Les relations sont représentées sous forme d'arête sur la carte dactivités. Si aucune valeur n'est définie, l'opération inclut tous les homologues. Le contenu de l'objet est défini dans la section « topology_relationship » ci-dessous.

role: Corde

(Facultatif) Le rôle de l'équipement homologue par rapport à l'équipement d'origine.

Les valeurs suivantes sont valides :

• client
• server
• any

protocol: Corde

(Facultatif) Le protocole par lequel l'équipement d'origine communique, tel que « HTTP ». Si aucune valeur n'est définie, l'objet inclut un protocole.

peer_in: Tableau d'objets

(Facultatif) La liste d'un ou de plusieurs appareils homologues à inclure dans le graphe topologique. Seules les relations avec les homologues de l'objet source spécifié sont incluses. Le contenu de l'objet est défini dans la section « topology_source » ci-dessous.

object_type: Corde

Type d'objet source.

Les valeurs suivantes sont valides :

• all_devices
• device_group
• device

object_id: Numéro

Identifiant unique de l'objet source. Défini sur 0 si la valeur du paramètre « object_type » est « all_devices ».

peer_not_in: Tableau d'objets

(Facultatif) La liste d'un ou de plusieurs appareils homologues à exclure du graphe topologique. Les relations avec les appareils homologues de l'objet source spécifié sont exclues. Le contenu de l'objet est défini dans la section « topology_source » ci-dessous.

object_type: Corde

Type d'objet source.

Les valeurs suivantes sont valides :

• all_devices
• device_group
• device

object_id: Numéro

Identifiant unique de l'objet source. Défini sur 0 si la valeur du paramètre « object_type » est « all_devices ».

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

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

Copier

GET /activitymaps

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

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

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

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de la carte dactivités.

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

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

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de la carte dactivités.

body: Objet

Les propriétés de la requête topologique.

from: Numéro

L'horodateur de début de la plage temporelle recherchée par la requête, exprimé en millisecondes depuis l'époque.

until: Numéro

(Facultatif) L'horodateur de fin de la plage de temps recherchée par la requête, exprimé en millisecondes depuis l'époque. Si aucune valeur n'est définie, la fin de la requête est par défaut « maintenant ».

edge_annotations: Tableau de chaînes

(Facultatif) La liste d'une ou plusieurs annotations de bord à inclure dans la requête topologique.

Les valeurs suivantes sont valides :

• protocols
• appearances

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

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

Copier

DELETE /activitymaps/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de la carte dactivités.

PATCH /activitymaps/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de la carte dactivités.

body: Objet

Les propriétés de la carte dactivités à mettre à jour.

GET /activitymaps/{id}/sharing

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de la carte dactivités.

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

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

PUT /activitymaps/{id}/sharing

Spécifiez les paramètres suivants.

body: Objet

Les utilisateurs et leurs niveaux d'autorisation.

id: Numéro

Identifiant unique de la carte dactivités.

PATCH /activitymaps/{id}/sharing

Spécifiez les paramètres suivants.

body: Objet

Les utilisateurs et leurs niveaux d'autorisation.

id: Numéro

Identifiant unique de la carte dactivités.

GET /alerts

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

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

Spécifiez les paramètres suivants.

body: Objet

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

description: Corde

Description facultative de l'alerte.

notify_snmp: Booléen

(Facultatif) Indique s'il faut envoyer une interruption SNMP lorsqu'une alerte est générée.

field_op: Corde

Type de comparaison entre les champs field_name et field_name2 lors de l'application d'un ratio. Applicable uniquement aux alertes par seuil.

Les valeurs suivantes sont valides :

• /
• null

stat_name: Corde

Nom de la statistique de l'alerte. Applicable uniquement aux alertes par seuil.

disabled: Booléen

(Facultatif) Indique si l'alerte est désactivée.

operator: Corde

Opérateur logique appliqué lors de la comparaison de la valeur du champ d'opérande aux conditions d'alerte. Applicable uniquement aux alertes par seuil.

Les valeurs suivantes sont valides :

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

operand: Corde

La valeur à comparer aux conditions d'alerte. La méthode de comparaison est spécifiée par la valeur du champ opérateur. Applicable uniquement aux alertes par seuil.

field_name: Corde

Nom de la métrique surveillée. Applicable uniquement aux alertes par seuil.

name: Corde

Le nom unique et convivial de l'alerte.

cc: Tableau de chaînes

Liste des adresses e-mail, non incluses dans un groupe de messagerie, pour recevoir des notifications.

apply_all: Booléen

Indique si l'alerte est attribuée à toutes les sources de données disponibles.

severity: Numéro

(Facultatif) Le niveau de gravité de l'alerte, qui est affiché dans l'historique des alertes, les notifications par e-mail et les pièges SNMP. Les niveaux de gravité de 0 à 2 nécessitent une attention immédiate. Les niveaux de gravité sont décrits dans le Guide de l'API REST.

author: Corde

Nom de l'utilisateur qui a créé l'alerte.

param: Objet

Le premier paramètre d'alerte, qui est soit un modèle clé, soit un point de données. Applicable uniquement aux alertes par seuil.

interval_length: Numéro

Durée de l'intervalle d'alerte, exprimée en secondes. Applicable uniquement aux alertes par seuil.

Les valeurs suivantes sont valides :

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

param2: Objet

Le deuxième paramètre d'alerte, qui est soit un modèle clé, soit un point de données. Applicable uniquement aux alertes par seuil.

units: Corde

Intervalle dans lequel évaluer la condition d'alerte. Applicable uniquement aux alertes par seuil.

Les valeurs suivantes sont valides :

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

field_name2: Corde

La deuxième métrique surveillée lors de l'application d'un ratio. Applicable uniquement aux alertes par seuil.

refire_interval: Numéro

(Facultatif) Intervalle de temps pendant lequel les conditions d'alerte sont surveillées, exprimé en secondes.

Les valeurs suivantes sont valides :

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

type: Corde

Type d'alerte.

Les valeurs suivantes sont valides :

• threshold

object_type: Corde

Type de source métrique surveillée par la configuration d'alerte. Applicable uniquement aux alertes de détection.

Les valeurs suivantes sont valides :

• application
• device

protocols: Tableau de chaînes

(Facultatif) La liste des protocoles surveillés. Applicable uniquement aux alertes de détection.

categories: Tableau de chaînes

(Facultatif) La liste d'une ou plusieurs catégories de détection. Une alerte est générée uniquement si une détection est identifiée dans les catégories spécifiées. Applicable uniquement aux alertes de détection.

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

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

Copier

GET /alerts/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'alerte.

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

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

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'alerte.

PATCH /alerts/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour des valeurs de propriété spécifiées à l'alerte.

id: Numéro

Identifiant unique de l'alerte.

GET /alerts/{id}/stats

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'alerte.

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

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

GET /alerts/{id}/devicegroups

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'alerte.

POST /alerts/{id}/devicegroups

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les groupes d'équipements assignés ou non à l'alerte.

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 l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du groupe déquipements.

id: Numéro

Identifiant unique de l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du groupe déquipements.

id: Numéro

Identifiant unique de l'alerte.

GET /alerts/{id}/emailgroups

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'alerte.

POST /alerts/{id}/emailgroups

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les groupes de messagerie attribués et non affectés à l'alerte.

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 l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du groupe de messagerie.

id: Numéro

Identifiant unique de l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du groupe de messagerie.

id: Numéro

Identifiant unique de l'alerte.

GET /alerts/{id}/exclusionintervals

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'alerte.

POST /alerts/{id}/exclusionintervals

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les intervalles d'exclusion attribués et non attribués à l'alerte.

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 l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'intervalle d'exclusion.

id: Numéro

Identifiant unique de l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'intervalle d'exclusion.

id: Numéro

Identifiant unique de l'alerte.

GET /alerts/{id}/devices

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'alerte.

POST /alerts/{id}/devices

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les appareils assignés et non affectés à l'alerte.

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 l'alerte.

POST /alerts/{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 l'alerte.

DELETE /alerts/{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 l'alerte.

GET /alerts/{id}/networks

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'alerte.

POST /alerts/{id}/networks

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les réseaux assignés et non affectés à l'alerte.

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 l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du réseau.

id: Numéro

Identifiant unique de l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du réseau.

id: Numéro

Identifiant unique de l'alerte.

GET /alerts/{id}/applications

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'alerte.

POST /alerts/{id}/applications

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les applications attribuées et non attribuées à l'alerte.

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 l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'application.

id: Numéro

Identifiant unique de l'alerte.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'application.

id: Numéro

Identifiant unique de l'alerte.

Les niveaux de gravité suivants sont pris en charge. Les niveaux de gravité de 0 à 2 nécessitent une attention immédiate.

GET /analysispriority/{appliance_id}/manager

Spécifiez les paramètres suivants.

appliance_id: Numéro

Identifiant de la sonde locale. Cette valeur doit être définie sur 0.

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

{
    "manager": {}
}

GET /analysispriority/config/{appliance_id}

Spécifiez les paramètres suivants.

appliance_id: Numéro

Identifiant d'une sonde. Définissez cette valeur sur 0 si vous faites appel à une sonde.

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

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

PUT /analysispriority/config/{appliance_id}

Spécifiez les paramètres suivants.

body: Objet

Propriétés des règles d'analyse des priorités.

autofill_advanced: Booléen

Indique s'il faut placer automatiquement les appareils dans Analyse avancée jusqu'à ce que leur capacité soit atteinte. Les appareils de la liste advanced_rules sont priorisés, suivis des appareils de la liste standard_rules, puis de l'heure de découverte de l'équipement. La capacité d'Analyse avancée est déterminée par la licence du système ExtraHop.

advanced_rules: Tableau d'objets

(Facultatif) Les règles de priorité de l'Analyse avancée pour un groupe de déquipements.

type: Corde

Type de groupe auquel les règles de priorité d'analyse s'appliquent.

Les valeurs suivantes sont valides :

• device_group

object_id: Numéro

Identifiant unique du groupe.

description: Corde

(Facultatif) Description des règles de priorité d'analyse.

autofill_standard: Booléen

Indique s'il faut placer automatiquement les appareils dans l'analyse standard jusqu'à ce que leur capacité totale soit atteinte. Les appareils de la liste standard_rules sont priorisés, suivis de l'heure de découverte de l'équipement. La capacité totale est déterminée par la licence du système ExtraHop.

standard_rules: Tableau d'objets

(Facultatif) Les règles de priorité d'analyse standard pour un groupe déquipements.

type: Corde

Type de groupe auquel les règles de priorité d'analyse s'appliquent.

Les valeurs suivantes sont valides :

• device_group

object_id: Numéro

Identifiant unique du groupe.

description: Corde

(Facultatif) Description des règles de priorité d'analyse.

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

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

Copier

appliance_id: Numéro

Identifiant d'une sonde. Définissez cette valeur sur 0 si vous faites appel à une sonde.

PATCH /analysispriority/{appliance_id}/manager

Spécifiez les paramètres suivants.

body: Objet

ID du capteur ou de la console qui gérera les règles de priorité d'analyse pour le capteur local. Définissez cette valeur sur 0 pour rétablir la gestion sur la sonde locale.

manager: Numéro

Identifiant unique de la sonde ou de la console de gestion.

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

{
    "manager": 0
}

Copier

appliance_id: Numéro

Identifiant de la sonde locale. Cette valeur doit être définie sur 0.

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 /appliances

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

Spécifiez les paramètres suivants.

id: Numéro

Spécifiez l'identifiant unique de l'appliance distante.

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

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

DELETE /appliances/{id}

Spécifiez les paramètres suivants.

id: Numéro

Spécifiez l'identifiant unique de l'appliance distante.

POST /appliances

Spécifiez les paramètres suivants.

body: Objet

Spécifiez les propriétés de la nouvelle connexion.

host: Corde

Le nom d'hôte de l'appliance distante.

remote_setup_password: Corde

(Facultatif) Le mot de passe du compte utilisateur de configuration sur le stockage des paquets EXA ou ExtraHop cible. Ce paramètre n'est pas obligatoire si l'appliance distante est un nœud d'un cluster Explore déjà connecté à la console. Ce paramètre n'est pas valide si l'appliance distante est une sonde.

remote_pairing_token: Corde

(Facultatif) Le jeton généré sur la sonde cible. Vous devez spécifier ce paramètre pour vous authentifier auprès de la sonde cible. Ce paramètre n'est pas valide si vous vous connectez à un système de stockage des paquets EXA ou ExtraHop.

fingerprint: Corde

(Facultatif) L'empreinte digitale de l'appareil distant. Si vous connectez une console à un système de stockage des paquets EXA ou ExtraHop, ce champ est obligatoire. Sinon, pour contourner la vérification par empreinte digitale, spécifiez « insecure_skip_verification ». Notez que le contournement de la vérification peut permettre des attaques de type « man-in-the-middle ».

reset_configuration: Booléen

(Facultatif) Indique s'il convient de réinitialiser la configuration de l'appliance distante.

remote_nickname_for_local: Corde

(Facultatif) Le surnom de l'appliance distante, auquel fait référence l'appliance locale. Si vous connectez une sonde à un autre appareil, ce champ est obligatoire.

local_nickname_for_remote: Corde

(Facultatif) Le surnom de l'appliance locale, auquel fait référence l'appliance distante.

remote_appliance_type: Corde

Type d'appareil pour la nouvelle connexion.

Les valeurs suivantes sont valides :

• command
• explore
• discover
• trace

manages_local: Booléen

(Facultatif) Indique si l'appliance distante gère l'appliance locale.

managed_by_local: Booléen

Indique si l'appliance distante est gérée par l'appliance locale. Si vous connectez une console à un capteur, ce champ n'est pas obligatoire car la console gère toujours les capteurs connectés.

data_access: Booléen

Indique si les données peuvent être partagées entre les appliances locales et distantes.

product_key: Corde

(Facultatif) La clé de produit de l'appliance cible. Si ce paramètre est spécifié, la licence de l'appliance cible est associée à la clé de produit. Ce paramètre n'est pas valide lorsque le paramètre remote_pairing_token est spécifié.

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

{
    "data_access": true,
    "fingerprint": "string",
    "host": "string",
    "local_nickname_for_remote": "string",
    "managed_by_local": true,
    "manages_local": true,
    "product_key": "string",
    "remote_appliance_type": "string",
    "remote_nickname_for_local": "string",
    "remote_pairing_token": "string",
    "remote_setup_password": "string",
    "reset_configuration": true
}

Copier

GET /appliances/{ids_id}/association

Spécifiez les paramètres suivants.

ids_id: Numéro

Spécifiez l'ID de la sonde IDS.

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

{
    "associated_sensor_id": 0
}

POST /appliances/{ids_id}/association

Spécifiez les paramètres suivants.

ids_id: Numéro

Spécifiez l'ID de la sonde IDS.

body: Objet

Spécifiez l'ID de la sonde réseau danalyse de paquets.

associated_sensor_id: Numéro

ID de la sonde réseau danalyse de paquets.

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

{
    "associated_sensor_id": 0
}

Copier

GET /appliances/{id}/productkey

Spécifiez les paramètres suivants.

id: Numéro

Spécifiez l'identifiant unique de l'appliance distante.

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

{
    "product_key": "string"
}

GET /appliances/firmware/next

Spécifiez les paramètres suivants.

ids: Corde

(Facultatif) Une liste CSV d'identifiants uniques pour les appliances distantes. Si ce paramètre est spécifié, l'opération renvoie les versions du microprogramme vers lesquelles tous les appareils distants spécifiés peuvent être mis à niveau. Si ce paramètre n'est pas spécifié, l'opération renvoie les versions du microprogramme vers lesquelles tout appareil distant peut être mis à niveau.

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

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

GET /appliances/{id}/cloudservices

Spécifiez les paramètres suivants.

id: Numéro

Spécifiez l'identifiant unique de l'appliance. Cette valeur doit être définie sur 0, ce qui permet de sélectionner l'appliance locale.

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

{
    "connection_status": "string",
    "connection_status_color": "string",
    "enabled_services": [],
    "last_active_time": 0,
    "last_analyzed_time": 0
}

POST /appliances/firmware/upgrade

Spécifiez les paramètres suivants.

body: Objet

Les options de mise à niveau du microprogramme.

version: Corde

La version du microprogramme vers laquelle mettre à niveau les appareils. Vous pouvez récupérer une liste des versions valides à l'aide de l'opération GET /api/v1/appliances/firmware/next.

system_ids: Tableau de chiffres

Une liste d'identifiants uniques pour les appareils distants. Vous pouvez récupérer les identifiants des appareils à l'aide de l'opération GET /api/v1/appliances ; les identifiants des appareils sont renvoyés dans les champs d'identification de la réponse.

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

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

Copier

GET /applications/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'application.

include_criteria: Booléen

(Facultatif) Indique s'il faut inclure les critères associés à l'application dans la réponse.

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

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

Spécifiez les paramètres suivants.

body: Objet

Les propriétés de l'application.

node_id: Numéro

(Facultatif) L'identifiant unique de la sonde à laquelle cette application est associée. L'identifiant peut être récupéré via l'opération GET /appliances. Ce champ n'est valide que sur une console.

discovery_id: Corde

L'identifiant unique de l'application, qui est affiché sur la page de l'application dans le système ExtraHop.

display_name: Corde

Nom convivial de l'application.

description: Corde

(Facultatif) Description facultative de l'application.

criteria: Tableau d'objets

(Facultatif) Tableau de critères de protocole et de source associés à l'application. Le contenu de ce tableau est défini dans la section « critères » ci-dessous.

protocol_default: Corde

Protocoles par défaut surveillés par l'application. Les valeurs prises en charge sont « any » et « none ».

sources: Tableau d'objets

Tableau contenant une ou plusieurs sources métriques associées à l'application. L'application collecte uniquement les métriques provenant des sources spécifiées. Le contenu de ce tableau est défini dans la section « source » ci-dessous.

type: Corde

Type de source métrique associée à l'application. Les valeurs de type source prises en charge sont « device » et « device_group ».

id: Numéro

Identifiant unique de l'équipement ou du groupe d'équipements associé à l'application.

protocols: Objet

(Facultatif) Liste d'un ou de plusieurs mappages de protocoles et de rôles associés à l'application. L'application collecte uniquement des métriques à partir des protocoles spécifiés. Le format de chaque protocole est {'protocol' : 'role'}. Exemple : {'http' : 'serveur'}. Les valeurs de rôle prises en charge sont « client », « serveur », « any » ou « none ».

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

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

Copier

PATCH /applications/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour de propriétés spécifiées à l'application.

id: Numéro

Identifiant unique de l'application.

GET /applications

Spécifiez les paramètres suivants.

active_from: Numéro

(Facultatif) Renvoie uniquement les applications actives après la durée spécifiée. Les valeurs positives indiquent le temps en millisecondes écoulé depuis l'époque. Les valeurs négatives indiquent l'heure en millisecondes avant l'heure actuelle.

active_until: Numéro

(Facultatif) Renvoie uniquement les applications actives avant l'heure spécifiée. Les valeurs positives indiquent le temps en millisecondes écoulé depuis l'époque. Les valeurs négatives indiquent l'heure en millisecondes avant l'heure actuelle.

limit: Numéro

(Facultatif) Limitez le nombre de demandes renvoyées au nombre maximum spécifié.

offset: Numéro

(Facultatif) Ignorez les n premiers résultats de l'application. Ce paramètre est souvent associé au paramètre limite.

search_type: Corde

Type d'objet à rechercher.

Les valeurs suivantes sont valides :

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

value: Corde

(Facultatif) Les critères de recherche. Ajoutez une barre oblique avant et après les critères pour appliquer la correspondance RegEx.

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

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

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'application.

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

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

GET /applications/{id}/alerts

Spécifiez les paramètres suivants.

id: Numéro

Récupérez l'identifiant unique de l'application.

direct_assignments_only: Booléen

(Facultatif) Indique si les résultats sont limités aux alertes directement attribuées à l'application.

POST /applications/{id}/alerts

Spécifiez les paramètres suivants.

body: Objet

Attribuez ou annulez l'attribution de la liste spécifiée d'identifiants uniques pour les alertes.

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

Fournissez un identifiant unique pour l'application.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'alerte.

id: Numéro

Identifiant unique de l'application.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'alerte.

id: Numéro

Identifiant unique de l'application.

GET /applications/{id}/dashboards

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'application.

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
}

GET /bundles

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

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

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

POST /bundles

Spécifiez les paramètres suivants.

body: Corde

Une exportation de bundle au format JSON.

name: Corde

Le nom convivial du bundle.

description: Corde

(Facultatif) Description facultative du bundle.

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

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

Copier

GET /bundles/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du bundle.

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

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

DELETE /bundles/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du bundle.

POST /bundles/{id}/apply

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du bundle.

body: Objet

Les options de configuration pour appliquer le bundle.

policy: Corde

Indique si les objets en conflit doivent être remplacés ou ignorés.

Les valeurs suivantes sont valides :

• overwrite
• skip

include_assignments: Booléen

Indique si les assignations d'objets doivent être restaurées avec le bundle.

node_ids: Tableau de nombres

Une liste d'identifiants uniques pour les capteurs sur lesquels appliquer le bundle. Ce champ n'est valide que sur une console.

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

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

Copier

POST /cloud/connect

Spécifiez les paramètres suivants.

body: Objet

Le jeton que vous avez généré à partir de Reveal (x) 360.

cloud_token: Corde

Le jeton que vous avez généré à partir de Reveal (x) 360.

nickname: Corde

Un surnom pour identifier facilement la sonde.

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

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

Copier

GET /customdevices

Spécifiez les paramètres suivants.

include_criteria: Booléen

(Facultatif) Indique si les critères d'équipement personnalisés doivent être inclus.

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

{
    "author": "string",
    "criteria": [],
    "description": "string",
    "disabled": true,
    "extrahop_id": "string",
    "id": 0,
    "mod_time": 0,
    "name": "string"
}

GET /customdevices/{id}

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement personnalisé.

include_criteria: Booléen

(Facultatif) Indique si les critères d'équipement personnalisés doivent être inclus.

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

{
    "author": "string",
    "criteria": [],
    "description": "string",
    "disabled": true,
    "extrahop_id": "string",
    "id": 0,
    "mod_time": 0,
    "name": "string"
}

DELETE /customdevices/{id}

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement personnalisé.

POST /customdevices

Spécifiez les paramètres suivants.

body: Objet

Appliquez les valeurs de propriété spécifiées au nouvel équipement personnalisé.

author: Corde

Le nom du créateur de l'équipement personnalisé.

extrahop_id: Corde

(Facultatif) Identifiant unique pour l'équipement personnalisé. Si ce champ n'est pas spécifié, un identifiant est généré à partir du nom personnalisé de l'équipement. L'identifiant ne peut pas contenir d'espaces et ne peut pas être modifié une fois l'équipement personnalisé enregistré.

name: Corde

Nom convivial de l'équipement personnalisé.

description: Corde

(Facultatif) Description facultative de l'équipement personnalisé.

disabled: Booléen

Indique si l'équipement personnalisé est inactif.

criteria: Tableau d'objets

(Facultatif) Un ensemble de critères d'équipement personnalisés pour cet équipement. Si ce champ est spécifié avec la méthode PATCH, tous les critères précédemment spécifiés sont supprimés.

ipaddr: Corde

L'adresse IP à laquelle l'équipement personnalisé doit correspondre.

ipaddr_direction: Corde

La direction du trafic à laquelle l'adresse ipaddr doit correspondre. Les critères déterminent la direction du trafic à destination ou en provenance de l'adresse ipaddr qui correspond.

Les valeurs suivantes sont valides :

• any
• dst
• src

ipaddr_peer: Corde

L'adresse IP avec laquelle l'adresse de l'iPad communique doit correspondre à l'équipement personnalisé. S'il est spécifié, ce paramètre limite le trafic correspondant à l'équipement personnalisé. Par exemple, si ipaddr_direction est « src », l'équipement personnalisé fait uniquement correspondre le trafic vers l'adresse ipaddr_peer à partir de l'adresse ipaddr. Ce paramètre n'est valide que si ipaddr est spécifié et que ipaddr_direction n'est pas « any ».

src_port_min: Numéro

La limite inférieure du port source à laquelle correspond l'équipement personnalisé. Valeurs prises en charge : 1-65535.

src_port_max: Numéro

La limite maximale du port source à laquelle l'équipement personnalisé doit correspondre. Valeurs prises en charge : 1-65535.

dst_port_min: Numéro

La limite inférieure du port de destination à laquelle correspond l'équipement personnalisé. Valeurs prises en charge : 1-65535.

dst_port_max: Numéro

La limite maximale du port de destination à laquelle l'équipement personnalisé doit correspondre. Valeurs prises en charge : 1-65535.

vlan_min: Numéro

La limite inférieure du VLAN à laquelle l'équipement personnalisé doit correspondre.

vlan_max: Numéro

La limite VLAN maximale à laquelle l'équipement personnalisé doit correspondre.

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

{
    "author": "string",
    "criteria": {
        "ipaddr": "string",
        "ipaddr_direction": "string",
        "ipaddr_peer": "string",
        "src_port_min": 0,
        "src_port_max": 0,
        "dst_port_min": 0,
        "dst_port_max": 0,
        "vlan_min": 0,
        "vlan_max": 0
    },
    "description": "string",
    "disabled": true,
    "extrahop_id": "string",
    "name": "string"
}

Copier

PATCH /customdevices/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour de la valeur des propriétés spécifiées à l'équipement personnalisé.

id: Numéro

L'identifiant unique de l'équipement personnalisé.

GET /customizations

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

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

{
    "auto": true,
    "create_time": 0,
    "id": 0,
    "name": "string",
    "recovered": true
}

POST /customizations

Spécifiez les paramètres suivants.

body: Objet

Nom unique pour le fichier de sauvegarde.

name: Corde

Nom unique pour le fichier de sauvegarde.

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

{
    "name": "string"
}

Copier

GET /customizations/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du fichier de sauvegarde.

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

{
    "auto": true,
    "create_time": 0,
    "id": 0,
    "name": "string",
    "recovered": true
}

DELETE /customizations/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du fichier de sauvegarde.

POST /customizations/{id}/apply

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du fichier de sauvegarde.

POST /customizations/{id}/download

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du fichier de sauvegarde.

GET /customizations/status

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

{
    "did_last_succeed": true,
    "last_attempt_time": 0,
    "last_success_time": 0
}

GET /dashboards

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

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

GET /dashboards/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du tableau de bord.

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

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

DELETE /dashboards/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du tableau de bord.

PATCH /dashboards/{id}

Spécifiez les paramètres suivants.

body: Objet

Le nom d'utilisateur du propriétaire du tableau de bord.

id: Numéro

Identifiant unique du tableau de bord.

GET /dashboards/{id}/sharing

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du tableau de bord.

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

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

PUT /dashboards/{id}/sharing

Spécifiez les paramètres suivants.

body: Objet

Les utilisateurs et leurs niveaux d'autorisation.

id: Numéro

Identifiant unique du tableau de bord.

PATCH /dashboards/{id}/sharing

Spécifiez les paramètres suivants.

body: Objet

Les utilisateurs et leurs niveaux d'autorisation.

id: Numéro

Identifiant unique du tableau de bord.

GET /dashboards/{id}/reports

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du tableau de bord.

GET /devices

Spécifiez les paramètres suivants.

active_from: Numéro

(Facultatif) L'horodateur de début de la demande. Renvoie uniquement les appareils actifs 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é. Voir le Guide de l'API REST pour les unités de temps et les suffixes pris en charge.

active_until: Numéro

(Facultatif) L'horodateur de fin de la demande. Renvoie uniquement l'équipement actif avant cette heure. Suit les mêmes directives relatives aux valeurs temporelles que le paramètre active_from.

limit: Numéro

(Facultatif) Limitez le nombre d'appareils renvoyés au nombre maximum spécifié.

offset: Numéro

(Facultatif) Ignorez les premiers résultats de l'équipement. Ce paramètre est souvent associé au paramètre limite.

search_type: Corde

Indique le champ à rechercher.

Les valeurs suivantes sont valides :

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

value: Corde

(Facultatif) Spécifie les critères de recherche.

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

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

Spécifiez les paramètres suivants.

body: Objet

Les critères de l'équipement.

active_from: Numéro

(Facultatif) L'horodateur de début de la demande. Renvoie uniquement les appareils actifs 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é. Voir le Guide de l'API REST pour les unités de temps et les suffixes pris en charge.

active_until: Numéro

(Facultatif) L'horodateur de fin de la demande. Renvoie uniquement les appareils actifs avant cette heure. Suit les mêmes directives relatives aux valeurs temporelles que le paramètre active_from.

limit: Numéro

(Facultatif) Limitez le nombre d'appareils renvoyés au nombre maximum spécifié.

offset: Numéro

(Facultatif) Ignorez le nombre d'appareils spécifié. Ce paramètre est souvent associé au paramètre limit pour paginer les ensembles de résultats.

filter: Objet

(Facultatif) Spécifiez les critères de filtre pour les résultats de recherche.

field: Corde

Nom du champ sur lequel filtrer les résultats. La recherche compare le contenu du paramètre de champ à la valeur du paramètre d'opérande.

Les valeurs suivantes sont valides :

• 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: 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 ou nombre ou objet ou tableau

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 d'opérateur. Vous pouvez spécifier l'opérande sous la forme d'une chaîne, d'un entier ou d'un objet. Pour plus d'informations sur les valeurs des objets, consultez le Guide de l'API REST.

rules: Tableau d'objets

Tableau d'un ou de plusieurs objets de filtre, qui peuvent être incorporés de manière récursive. Seuls les opérateurs « et », « ou » et « non » sont autorisés pour ce paramètre.

result_fields: Tableau de chaînes

(Facultatif) Renvoie les champs spécifiés et l'identifiant de l'équipement. Si cette option n'est pas spécifiée, tous les champs sont renvoyés.

Les valeurs suivantes sont valides :

• 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

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

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

Copier

GET /devices/{id}

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

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

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour des valeurs de propriété spécifiées à l'équipement.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

GET /devices/{id}/activity

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

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

GET /devices/{id}/ipaddrs

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

from: Numéro

(Facultatif) Récupère les adresses IP associées à l'équipement après la date spécifiée, exprimées en millisecondes depuis l'époque.

until: Numéro

(Facultatif) Récupère les adresses IP associées à l'équipement avant la date spécifiée, exprimées en millisecondes depuis l'époque.

GET /devices/{id}/dnsnames

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

from: Numéro

(Facultatif) Récupère les noms DNS associés à l'équipement après la date spécifiée, exprimés en millisecondes depuis l'époque.

until: Numéro

(Facultatif) Récupère les noms DNS associés à l'équipement avant la date spécifiée, exprimés en millisecondes depuis l'époque.

GET /devices/{id}/triggers

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

direct_assignments_only: Booléen

(Facultatif) Limitez les résultats aux seuls déclencheurs directement affectés à l'équipement.

POST /devices/{id}/triggers

Spécifiez les paramètres suivants.

body: Objet

Liste d'identifiants uniques pour les déclencheurs assignés ou non à l'équipement.

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

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du déclencheur.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du déclencheur.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

GET /devices/{id}/dashboards

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

GET /devices/{id}/devicegroups

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'équipement.

active_from: Numéro

(Facultatif) L'horodateur de début de la demande. Renvoie uniquement les groupes d'équipements dynamiques auxquels l'équipement appartenait 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é. Voir le Guide de l'API REST pour les unités de temps et les suffixes pris en charge.

active_until: Numéro

(Facultatif) L'horodateur de fin de la demande. Renvoie uniquement les groupes d'équipements dynamiques auxquels l'équipement appartenait avant cette date. Suit les mêmes directives relatives aux valeurs temporelles que le paramètre active_from.

POST /devices/{id}/devicegroups

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les groupes d'équipements assignés ou non à l'équipement.

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

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du groupe déquipements.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du groupe déquipements.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

GET /devices/{id}/tags

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

POST /devices/{id}/tags

Spécifiez les paramètres suivants.

body: Objet

Liste d'identifiants uniques pour les balises attribuées et non attribuées à l'équipement.

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

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de la balise.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de la balise.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

GET /devices/{id}/alerts

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

direct_assignments_only: Booléen

(Facultatif) Limitez les résultats aux seules alertes directement attribuées à l'équipement.

POST /devices/{id}/alerts

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les alertes attribuées et non attribuées à l'équipement.

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

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'alerte.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'alerte.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

GET /devices/{id}/software

Spécifiez les paramètres suivants.

id: Numéro

L'identifiant unique de l'équipement, qui est affiché sous forme d'ID d'API sur la page de l'équipement dans le système ExtraHop.

from: Numéro

(Facultatif) Renvoie le logiciel observé sur l'équipement après la date spécifiée, exprimée en millisecondes depuis l'époque.

until: Numéro

(Facultatif) Renvoie le logiciel observé sur l'équipement avant la date spécifiée, exprimé en millisecondes depuis l'époque.

• 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 /devicegroups

Spécifiez les paramètres suivants.

since: Numéro

(Facultatif) Renvoie uniquement les groupes d'équipements modifiés après cette période, exprimés en millisecondes depuis l'époque.

all: Booléen

(Facultatif) Obsolète. Remplacé par le paramètre type.

name: Corde

(Facultatif) La valeur de recherche Regex pour filtrer les groupes d'équipements par nom.

type: Corde

(Facultatif) Renvoie uniquement les groupes d'équipements du type spécifié.

Les valeurs suivantes sont valides :

• user_created
• built_in
• all

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

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

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du groupe déquipements.

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

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

Spécifiez les paramètres suivants.

body: Objet

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

description: Corde

Description facultative du groupe déquipements.

name: Corde

Nom convivial du groupe déquipements.

include_custom_devices: Booléen

(Facultatif) Obsolète. Remplacé par le paramètre de filtre.

dynamic: Booléen

(Facultatif) Indique si le groupe déquipements est dynamique.

field: Corde

Obsolète. Remplacé par le paramètre de filtre.

Les valeurs suivantes sont valides :

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

value: Objet

(Facultatif) Obsolète. Remplacé par le paramètre de filtre.

filter: Objet

(Facultatif) Spécifiez les critères de filtre pour les résultats de recherche.

field: Corde

Nom du champ sur lequel filtrer les résultats. La recherche compare le contenu du paramètre de champ à la valeur du paramètre d'opérande.

Les valeurs suivantes sont valides :

• 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: 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
• ~
• !~

operand: Chaîne, nombre ou objet

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 d'opérateur. Vous pouvez spécifier l'opérande sous la forme d'une chaîne, d'un entier ou d'un objet. Pour plus d'informations sur les valeurs des objets, consultez le Guide de l'API REST.

rules: Tableau d'objets

Tableau d'un ou de plusieurs objets de filtre, qui peuvent être incorporés de manière récursive. Seuls les opérateurs « et », « ou » et « non » sont autorisés pour ce paramètre.

editors: Tableau de chaînes

(Facultatif) Liste des utilisateurs autorisés à modifier le groupe déquipements.

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

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

Copier

DELETE /devicegroups/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du groupe déquipements.

PATCH /devicegroups/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour des valeurs de propriété spécifiées à un groupe déquipements spécifique.

description: Corde

Description facultative du groupe déquipements.

name: Corde

Nom convivial du groupe déquipements.

include_custom_devices: Booléen

(Facultatif) Obsolète. Remplacé par le paramètre de filtre.

field: Corde

Obsolète. Remplacé par le paramètre de filtre.

Les valeurs suivantes sont valides :

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

value: Objet

(Facultatif) Obsolète. Remplacé par le paramètre de filtre.

filter: Objet

(Facultatif) Spécifiez les critères de filtre pour les résultats de recherche.

editors: Tableau de chaînes

(Facultatif) Liste des utilisateurs autorisés à modifier le groupe déquipements.

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

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

Copier

id: Numéro

Identifiant unique du groupe déquipements.

GET /devicegroups/{id}/alerts

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du groupe déquipements.

direct_assignments_only: Booléen

(Facultatif) Limitez les résultats aux seules alertes directement attribuées au groupe dequipment.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'alerte.

id: Numéro

Identifiant unique du groupe déquipements.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique de l'alerte.

id: Numéro

Identifiant unique du groupe déquipements.

POST /devicegroups/{id}/alerts

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les alertes assignés et non assignés au groupe déquipements.

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 du groupe déquipements.

GET /devicegroups/{id}/triggers

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du groupe déquipements.

direct_assignments_only: Booléen

(Facultatif) Limitez les résultats aux seuls déclencheurs directement affectés au groupe dequipment.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du déclencheur.

id: Numéro

Identifiant unique du groupe déquipements.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique du déclencheur.

id: Numéro

Identifiant unique du groupe déquipements.

POST /devicegroups/{id}/triggers

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les déclencheurs assignés ou non au groupe déquipements.

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 du groupe déquipements.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique d'un équipement.

id: Numéro

Identifiant unique du groupe déquipements.

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

Spécifiez les paramètres suivants.

child-id: Numéro

Identifiant unique d'un équipement.

id: Numéro

Identifiant unique du groupe déquipements.

POST /devicegroups/{id}/devices

Spécifiez les paramètres suivants.

body: Objet

Liste des identifiants uniques pour les appareils assignés et non assignés au groupe d'équipements.

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 du groupe déquipements.

GET /devicegroups/{id}/devices

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du groupe déquipements.

active_from: Numéro

(Facultatif) L'horodateur de début de la demande. Renvoie uniquement les appareils actifs 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é. Voir le Guide de l'API REST pour les unités de temps et les suffixes pris en charge.

active_until: Numéro

(Facultatif) L'horodateur de fin de la demande. Renvoie uniquement l'équipement actif avant cette heure. Suit les mêmes directives relatives aux valeurs temporelles que le paramètre active_from.

limit: Numéro

(Facultatif) Limitez le nombre d'appareils renvoyés.

offset: Numéro

(Facultatif) Ignorez les premiers résultats de l'équipement. Ce paramètre est souvent associé au paramètre limite.

GET /devicegroups/{id}/dashboards

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique du groupe déquipements.

• 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 /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 /exclusionintervals

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

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

Spécifiez les paramètres suivants.

body: Objet

Définissez les valeurs de propriétés spécifiées sur le nouvel intervalle d'exclusion.

name: Corde

Nom convivial de l'intervalle d'exclusion.

author: Corde

(Facultatif) Le nom du créateur de l'intervalle d'exclusion.

description: Corde

(Facultatif) Description facultative de l'intervalle d'exclusion.

interval_type: Corde

La fenêtre temporelle pendant laquelle l'intervalle d'exclusion a été évalué.

Les valeurs suivantes sont valides :

• onetime
• weekly
• daily

start: Numéro

Début de la plage de temps de l'intervalle d'exclusion, exprimé en secondes. Cette valeur est relative à l'époque pour les exclusions ponctuelles, par rapport à minuit pour les exclusions quotidiennes et par rapport au lundi à minuit pour les exclusions hebdomadaires.

end: Numéro

Fin de la plage de temps de l'intervalle d'exclusion, exprimée en secondes. Cette valeur est relative à l'époque pour les exclusions ponctuelles, par rapport à minuit pour les exclusions quotidiennes et par rapport au lundi à minuit pour les exclusions hebdomadaires.

alert_apply_all: Booléen

Indique si cet intervalle d'exclusion doit être appliqué à toutes les alertes.

trend_apply_all: Booléen

Indique si cet intervalle d'exclusion doit être appliqué à toutes les tendances.

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

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

Copier

GET /exclusionintervals/{id}

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'intervalle d'exclusion.

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

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

Spécifiez les paramètres suivants.

id: Numéro

Identifiant unique de l'intervalle d'exclusion.

PATCH /exclusionintervals/{id}

Spécifiez les paramètres suivants.

body: Objet

Appliquez les mises à jour des valeurs de propriété spécifiées à l'intervalle d'exclusion.

id: Numéro

Identifiant unique de l'intervalle d'exclusion.

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 sous forme de 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 du 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 Autre nom.

subject: Objet

Objet du certificat SSL. Pour consulter la liste des domaines concernés par le 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) État ou province du sujet (ST).

locality_name: Corde

(Facultatif) La localité du sujet (L).

organization_name: Corde

(Facultatif) L'organisation du sujet (O).

organizational_unit_name: Corde

(Facultatif) L'unité organisationnelle (UO) du sujet.

email_address: Corde

(Facultatif) L'adresse e-mail du sujet (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,
    "url_template": "string"
}

PATCH /extrahop/ticketing

Spécifiez les paramètres suivants.

body: Objet

Paramètres de suivi des tickets.

enabled: Booléen

(Facultatif) Indique comment les enquêtes de détection sont suivies. Si ce paramètre est défini sur true, les enquêtes sont suivies à partir d'un système de billetterie externe. Si ce paramètre est défini sur faux, les enquêtes sont suivies au sein de l'appliance.

url_template: Corde

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

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

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

Copier

PUT /extrahop/detections/access

Spécifiez les paramètres suivants.

body: Objet

Les détections accèdent aux paramètres de 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 pour certains utilisateurs. 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 du 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 le chargement d'une image via cURL ou un script Python, voir Mettre à jour 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. Si une mise à niveau échoue, 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 convient de 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 Management GUI, 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 permet à 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é de session SSL, qui permettent à l'appliance de recevoir et de déchiffrer les clés de session à partir du 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

Nom du processus.

Les valeurs suivantes sont valides :

• exadmin
• exalerts
• examf
• exapi
• exbridge
• excap
• exconfig
• exflowlogs
• exsnmpq
• exnotify
• exportal
• exremote
• exsearch
• 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 du fichier

Le fichier du bundle de ressources.