Guide de l'API REST ExtraHop Explore

Les objets du système ExtraHop peuvent être identifiés par n'importe quelle valeur unique, telle que l' adresse IP, l'adresse MAC, le nom ou l'identifiant du système. Toutefois, pour effectuer des opérations d'API sur un objet spécifique, vous devez localiser l'ID de l'objet. Vous pouvez facilement localiser l'ID de l'objet à l'aide des méthodes suivantes dans l'explorateur d'API REST.

• L'identifiant de l'objet est fourni dans les en-têtes renvoyés par une requête POST. Par exemple, si vous envoyez une requête POST pour créer une page, les en-têtes de réponse affichent une URL de localisation.

  La demande suivante a renvoyé l'emplacement de la balise nouvellement créée sous la forme /api/v1/tags/1 et l'identifiant du tag sous la forme 1.

  {
   "date": "Tue, 09 Nov 2021 18:21:00 GMT ",
   "via": "1.1 localhost",
   "server": "Apache",
   "content-type": "text/plain; charset=utf-8",
   "location": "/api/v1/tags/1",
   "cache-control": "private, max-age=0",
   "connection": "Keep-Alive",
   "keep-alive": "timeout=90, max=100",
   "content-length": "0"
  }

  Copier
• L'ID d'objet est fourni pour tous les objets renvoyés par une requête GET. Par exemple, si vous exécutez une requête GET sur tous les appareils, le corps de la réponse contient des informations pour chaque équipement, y compris l'identifiant.

  Le corps de réponse suivant affiche une entrée pour un seul équipement, avec un ID de 10212 :

  {
   "mod_time": 1448474346504,
   "node_id": null,
   "id": 10212,
   "extrahop_id": "test0001",
   "description": null,
   "user_mod_time": 1448474253809,
   "discover_time": 1448474250000,
   "vlanid": 0,
   "parent_id": 9352,
   "macaddr": "00:05:G3:FF:FC:28",
   "vendor": "Cisco",
   "is_l3": true,
   "ipaddr4": "10.10.10.5",
   "ipaddr6": null,
   "device_class": "node",
   "default_name": "Cisco5",
   "custom_name": null,
   "cdp_name": "",
   "dhcp_name": "",
   "netbios_name": "",
   "dns_name": "",
   "custom_type": "",
   "analysis_level": 1
  },

  Copier
• L'ID de l'objet est fourni dans l'URL de la plupart des objets. Par exemple, dans le système ExtraHop, cliquez sur Actifs, puis Appareils. Sélectionnez n'importe quel équipement et consultez l'URL. Dans l'exemple suivant, l'URL de la page de l'équipement indique Oid=10180.

  https://10.10.10.205/extrahop/#/Devices?details=true&device
  Oid=10180&from=6&interval_type=HR&until=0&view=l2stats

  Copier

  Pour effectuer des demandes spécifiques pour cet équipement, ajoutez 10180 au identifiant champ dans l'explorateur d'API REST ou dans le paramètre body de votre demande.

  L'URL pour tableaux de bord affiche un short_code, qui apparaît après /Dashboard. Lorsque vous ajoutez le short_code à l'explorateur d'API REST ou à votre demande, vous devez ajouter un tilde au code court.

  Dans l'exemple suivant, KMC9y est le short_code. Pour effectuer des demandes pour ce tableau de bord, ajoutez ~kmC9Y comme valeur du champ short_code.

  https://10.10.10.205/extrahop/#/Dashboard/kmC9Y/?from=6&interval_
  type=HR&until=0

  Copier

  Vous pouvez également trouver le short_code et l'ID du tableau de bord dans les propriétés du tableau de bord de tout tableau de bord, accessibles depuis le menu de commande . Certaines opérations d'API, telles que DELETE, nécessitent l'ID du tableau de bord.

Une clé d'API permet à un utilisateur d'effectuer des opérations via l'API REST ExtraHop.

Vous pouvez générer la clé d'API initiale pour le compte utilisateur configuré via l'API REST. Toutes les autres clés d' API sont générées via la page Accès aux API dans les paramètres d'administration.

Le tableau suivant présente toutes les opérations que vous pouvez effectuer sur cette ressource :

Le système ExtraHop consiste en un réseau d'appareils ExtraHop connectés, tels que capteurs, consoles, des magasins de disques et des magasins de paquets qui exécutent des tâches telles que la surveillance du trafic, l' analyse des données, le stockage des données et l'identification des détections.

Vous pouvez récupérer des informations et établir des connexions pour les appareils ExtraHop locaux et distants.

Le tableau suivant présente toutes les opérations que vous pouvez effectuer sur cette ressource :

Cette ressource fournit des métadonnées sur le système ExtraHop.

Le tableau suivant présente toutes les opérations que vous pouvez effectuer sur cette ressource :

Les informations d'implémentation et les instructions pour chaque opération sont documentées dans l'explorateur d'API REST. Vous pouvez cliquer sur n'importe quelle opération dans l'explorateur d'API REST pour afficher les informations d' implémentation telles que les paramètres, la classe de réponse et les messages, ainsi que le modèle et le schéma JSON.

Vous pouvez suivre la progression de certaines tâches d'administration lancées via l' API REST. Si une requête REST crée une tâche, l'ID de la tâche est renvoyé dans le location en-tête de la réponse. Les opérations suivantes créent des emplois :

• POST ​/extrahop​/firmware​/latest​/upgrade
• POST ​/extrahop​/sslcert

Le tableau suivant présente toutes les opérations que vous pouvez effectuer sur cette ressource :

Cette ressource vous permet de récupérer et de définir des clés de produit ou de récupérer et de définir une licence.

Le tableau suivant présente toutes les opérations que vous pouvez effectuer sur cette ressource :

Le fichier de configuration en cours est un document JSON qui contient des informations de configuration système de base pour le système ExtraHop.

Le tableau suivant présente toutes les opérations que vous pouvez effectuer sur cette ressource :

Vous pouvez automatiser les mises à niveau du micrologiciel de vos appareils ExtraHop via l'API REST ExtraHop. Ce guide fournit des instructions pour effectuer une mise à niveau via l' explorateur d'API REST, une commande cURL et un script Python.

Bien que le processus de mise à niveau du microprogramme soit similaire sur tous les appareils ExtraHop, certains appareils comportent des considérations ou étapes supplémentaires que vous devez prendre en compte avant d'installer le microprogramme dans votre environnement. Si vous avez besoin d' aide pour votre mise à niveau, contactez le support ExtraHop.

Tous les appareils doivent répondre aux exigences suivantes :

• La version du microprogramme doit être compatible avec le modèle de votre appareil.
• La version du microprogramme de votre appliance doit être prise en charge par la version de mise à niveau.
• Les appareils de commande doivent exécuter un microprogramme supérieur ou égal à celui des appareils connectés.
• Les appliances Discover doivent exécuter un microprogramme supérieur ou égal à celui des appliances Explore and Trace connectées.

Si votre déploiement inclut uniquement un sonde, passez au Explorateur d'API, cURL ou Python instructions de mise à niveau.

Si votre déploiement inclut des types d'appareils supplémentaires, vous devez résoudre les dépendances suivantes avant de suivre les instructions de mise à niveau.