Lancer la Démo

Spécifiez des marques et des modèles d'équipements personnalisés via l'API REST

L'API REST ExtraHop vous permet de spécifier des marques et des modèles personnalisés pour les appareils. Vous pouvez mettre à jour les appareils via l'explorateur d'API REST ou automatiser la procédure en lisant les critères relatifs aux équipements à partir d'un fichier CSV ou similaire via un script d'API REST.

Before you begin

  • Pour les capteurs et les machines virtuelles ECA, vous devez disposer d'une clé d'API valide pour apporter des modifications via l' API REST et suivre les procédures ci-dessous. (Voir Génération d'une clé d'API.)
  • Pour Reveal (x) 360, vous devez disposer d'informations d'identification d'API REST valides pour apporter des modifications via l'API REST et suivre les procédures ci-dessous. (Voir Création d'informations d'identification pour l'API REST.)

Spécifiez une marque et un modèle personnalisés via l'explorateur d'API REST

Important :L'explorateur d'API REST n'est pas disponible sur Reveal (x) 360.

Récupérez l'identifiant de l'équipement

Avant de pouvoir spécifier une marque et un modèle personnalisés pour un équipement, vous devez récupérer l'ID de l' API REST de l'équipement.

  1. Dans un navigateur, accédez à l'explorateur d'API REST.
    L'URL est le nom d'hôte ou l'adresse IP de votre sonde ou console, suivi de /api/v1/explore/. Par exemple, si votre nom d'hôte est seattle-eda, l'URL est https://seattle-eda/api/v1/explore/.
  2. Cliquez Entrez la clé d'API puis collez ou saisissez votre clé d'API dans Clé d'API champ.
  3. Cliquez Autoriser puis cliquez sur Fermer.
  4. Cliquez POST /appareils/recherche.
  5. Cliquez Essayez-le.
    Le schéma JSON est automatiquement ajouté à la zone de texte des paramètres du corps.
  6. Dans le corps de la zone de texte, saisissez les critères de recherche qui sélectionnent l'équipement.
    Les critères de recherche suivants renvoient un équipement dont l'adresse IP est 10.10.10.200 :
    {
  "filter": {
    "field": "ipaddr",
    "operand": "10.10.10.200",
    "operator": "="
  }
}

    Pour plus d'informations sur les filtres de recherche d'équipements, voir Valeurs d'opérande pour la recherche d'équipements.

  7. Cliquez Envoyer une demande.
    Dans la section Corps de la réponse, notez id champ de l' équipement.

Spécifiez un équipement de valeur élevée

  1. Cliquez PATCH /appareils/ {id}.
  2. Cliquez Essayez-le.
  3. Dans le corps dans le champ, saisissez l'objet JSON suivant : 
    {
    "custom_criticality": "critical"
}
  4. Dans le identifiant dans ce champ, saisissez l'ID de l'équipement qui que vous avez récupéré lors de la procédure précédente.
  5. Cliquez Envoyer une demande.
    Si la demande aboutit, un code de réponse 204 apparaît dans la section Réponse du serveur.

Récupérez et exécutez l'exemple de script Python

Le référentiel GitHub ExtraHop contient un exemple de script Python qui lit les marques et les modèles personnalisés à partir d'un fichier CSV et les ajoute aux appareils dotés d'adresses IP spécifiées.

  1. Accédez au Référentiel GitHub d'exemples de code ExtraHop et téléchargez le contenu du specify_custom_make_model répertoire sur votre machine locale.
  2. Dans un éditeur de texte, ouvrez le custom_config.csv archivez et ajoutez l'adresse IP de chaque équipement que vous souhaitez mettre à jour, ainsi que les marques et modèles personnalisés pour chaque appareil.
    Remarque :Le fichier contient deux exemples d'entrées. Le script ignore la ligne d'en-tête.
  3. Dans un éditeur de texte, ouvrez le specify_custom_make_model.py archivez et remplacez les variables de configuration par des informations provenant de votre environnement.
    • Pour les capteurs et les machines virtuelles ECA, spécifiez les variables de configuration suivantes :

      HÔTE: L'adresse IP ou le nom d'hôte de la sonde ou de la machine virtuelle ECA.

      CLÉ_API: La clé API.

    • Pour Reveal (x) 360, spécifiez les variables de configuration suivantes :

      HÔTE: Le nom d'hôte de l'API Reveal (x) 360. Ce nom d'hôte est affiché sur la page d'accès à l'API Reveal (x) 360 sous API Endpoint. Le nom d'hôte n'inclut pas /oauth2/token.

      IDENTIFIANT: L'ID des informations d'identification de l'API REST Reveal (x) 360.

      SECRET: Le secret des informations d'identification de l'API REST Reveal (x) 360.

  4. Exécutez la commande suivante : 
    python3 specify_custom_make_model.py
    Remarque :Si le script renvoie un message d'erreur indiquant que la vérification du certificat SSL a échoué, assurez-vous que un certificat de confiance a été ajouté à votre sonde ou à votre console. Vous pouvez également ajouter le verify=False possibilité de contourner la vérification des certificats. Cependant, cette méthode n'est pas sûre et n'est pas recommandée. Le code suivant envoie une requête HTTP GET sans vérification de certificat :
    requests.get(url, headers=headers, verify=False)
Last modified 2024-02-13