Accès à la page de documentation interactive de l'API

La page de documentation de l'API interactive permet d'accéder aux détails techniques des API RESTful et d'essayer de faire des demandes d'API à votre serveur.

A propos de cette tâche

L'interface utilisateur de la documentation de l'API fournit des descriptions et la possibilité d'utiliser les interfaces API REST suivantes :
Tableau 1. Interfaces d'API REST
API REST Descriptif
/api/analytics Créer, mettre à jour et supprimer des actions personnalisées pour les règles.
/api/ariel Afficher les propriétés d'événement et de flux, créer des recherches d'événements et de flux et gérer les recherches.
/api/asset_model Renvoie une liste de tous les actifs du modèle. Vous pouvez également afficher une liste de toutes les recherches sauvegardées et de tous les types de propriétés d'actifs disponibles et mettre à jour un actif.
/api/auth Déconnecte et invalide la session en cours.
/api/config Affichez et gérez les titulaires, les domaines et les extensions QRadar® .
/api/data_classification Affichez toutes les catégories de haut niveau et de bas niveau, les enregistrements d'identificateur (QID) QRadar et les mappages d'événements. Vous pouvez également créer ou modifier des enregistrements et des mappages QID.
/api/forensics Gérer les récupérations et les cas de capture.
/api/gui_app_framework Installer et gérer les applications créées à l'aide de l'interface graphique Application Framework Software Development Kit.
/api/help Renvoie une liste des fonctions de l'API.
/api/qrm Gérer les groupes de recherche sauvegardés, les groupes de questions, les groupes de simulation, les groupes de recherche de topologie enregistrés et les groupes de modèles.
/api/qvm Extrait les actifs, les vulnérabilités, les réseaux, les services ouverts et les filtres. Vous pouvez également créer ou mettre à jour des tickets de rattrapage.
/api/reference_data Affiche et gère les collectes de données de référence.
/api/scanner Affiche, crée ou démarre une analyse distante associée à un profil d'analyse.
/api/services Exécutez des tâches telles que les recherches WHOIS, les recherches d'analyse de port, les recherches DNS et les recherches DIG. Vous pouvez également extraire des données de géolocalisation pour une adresse IP ou un ensemble d'adresses IP.
/api/siem Afficher, mettre à jour et fermer les infractions. Vous pouvez également ajouter des remarques et gérer des motifs de fermeture d'infraction.
/api/staged_config Extraire la configuration mise en scène pour les utilisateurs, les hôtes, les notifications, les réseaux distants et les services distants. Vous pouvez également lancer ou afficher l'état d'une action de déploiement, et mettre à jour et supprimer les règles Yara.
/api/system Gérez les hôtes serveur, les interfaces réseau et les règles de pare-feu.

Procédure

  1. Pour accéder à l'interface de documentation interactive de l'API, saisissez l'adresse URL dans votre navigateur web : https://ConsoleIPaddress/api_doc/.
  2. Sélectionnez la version de l'API que vous souhaitez utiliser dans la liste.
  3. Accédez au noeud final souhaité.
  4. Consultez la documentation du noeud final et définissez les paramètres de la demande.
  5. Cliquez sur Try it out pour envoyer la requête API à votre console et recevoir une réponse HTTPS correctement formatée.
    Remarque: Lorsque vous cliquez sur Try it out, l'action est effectuée sur le système QRadar . Toutes les actions ne peuvent pas être inversées, par exemple, vous ne pouvez pas rouvrir une infraction après avoir fermé.
  6. Passez en revue et rassemblez les informations dont vous avez besoin pour l'intégration à QRadar.