API REST pour AppScan Enterprise

About this task

Les API REST sont disponibles depuis une page interactive créée à l'aide de l'infrastructure Swagger. Accédez à la page interactive, en utilisant le lien https://<domain>:9443/ase/api/pages/apidocs.html, pour visualiser et exécuter les API afin de mieux comprendre leur fonctionnement.

Note :
Depuis la version 9.0.3.10 d'AppScan Enterprise, toutes les API de la section des API de gestion des examens sont également disponibles via Swagger.
Note :
Lorsque vous utilisez les REST API pour récupérer les détails des problèmes (par exemple, lorsque vous récupérez un problème unique ou une liste de tous les problèmes d'application), la charge utile de la réponse inclut désormais des attributs au niveau de l'analyse. Ces attributs fournissent les configurations Scan Type, Test Optimization Level et Test Policy associées au problème. Pour obtenir la liste complète des points de terminaison et des structures de charge utile, consultez l'interface Swagger.

Vous trouverez ci-dessous la liste des API disponibles dans AppScan Enterprise :

API Description
connexion Connexion à l'application avec un nom d'utilisateur et un mot de passe.
keylogin Connexion à l'application à l'aide d'une clé d'API générée.
déconnexion Déconnexion de l'application.
applications API permettant d'exécuter des opérations spécifiques aux applications, comme créer, éditer, supprimer, exporter, etc.
appimport API permettant d'importer des informations sur les applications à partir de fichiers, et de récupérer le statut et le journal récapitulatif des importations.
appattributedefinitions Récupération des détails des modèles de profil d'application.
accès Contrôle d'accès des applications – API permettant de créer, éditer, répertorier et supprimer les accès utilisateur aux applications.
issuetypes API permettant de créer, éditer, répertorier et supprimer des types d'anomalies.
problèmes API permettant de générer différents rapports, mettre à jour les anomalies, récupérer les détails des anomalies, récupérer le statut des travaux de rapport, etc.
issueimport API permettant d'importer les anomalies depuis un fichier, récupérer le statut et le journal récapitulatif des importations.
scanners API permettant de répertorier les scanners et d'afficher une icône pour un scanner donné.
issueattributedefinitions API permettant de récupérer les détails d'un modèle de profil d'anomalie.
tableau de bord API permettant de récupérer les données brutes des tableaux de bord.
résumés API permettant d'obtenir un résumé et un compte des applications/anomalies pour une requête spécifique.
modèles API permettant d'obtenir la liste des modèles, de charger et télécharger des modèles, et de récupérer les informations relatives aux modèles.
scansmanagement API permettant de répertorier et modifier les activités d'examen.
éléments de dossier API permettant de répertorier, créer, éditer, supprimer des éléments de dossiers, de répertorier les rapports, de récupérer des journaux d'examen, des statistiques, etc.
travaux API permettant de créer, modifier et télécharger des travaux dast.config, d'effectuer une action, de mettre à jour les configurations d'examen, de configurer les tests de contrôle d'accès défaillant, et plus encore.
Note :
Pour créer un travail à l'aide de l'API POST /jobs, le fichier zip dast.config doit contenir un fichier modèle .scant.
dossiers API permettant de créer, éditer, supprimer et répertorier des éléments de dossier, de modifier le rôle d'un dossier, etc.
politiques de test API permettant de répertorier toutes les stratégies de test disponibles, ainsi que les stratégies auxquelles un utilisateur a accès.
rapports API permettant de récupérer au format XML les données des rapports, les détails des anomalies, etc.
compte API permettant de récupérer, générer et supprimer des clés d'API.
currentuser_v2 API permettant de récupérer les informations sur l'utilisateur actuel.
types d'utilisateur API permettant de répertorier, créer, éditer, supprimer des types d'utilisateur et de répertorier les permissions liées aux types d'utilisateur.
permissions de sécurité utilisateur API permettant de créer, répertorier et supprimer les droits utilisateur de sécurité.
utilisateurs de la console API permettant de créer, éditer, répertorier et supprimer des utilisateurs.
groupes de serveurs API permettant de créer, éditer, répertorier et supprimer des groupes de serveurs.
standards API permettant de répertorier les normes de conformité disponibles, ainsi que les sections de normes de conformité données.
trends API permettant de récupérer les informations sur les tendances pour un type de métrique donné et de recalculer les tendances.
agentServer API pour obtenir une liste de tous les serveurs d'agents.
metrics API pour obtenir AppScan Enterprise les métadonnées et les informations sur la croissance de la taille de la base de données.
activitylog API pour obtenir une liste d'activités pour une période spécifiée.
vulnerablecomponent API pour gérer et récupérer des informations sur les versions de composants vulnérables.
Licence API pour obtenir la liste des droits de licence et leurs dates d'expiration.
historicdata API pour obtenir des données historiques pour les applications, y compris les métadonnées et les problèmes importés.
currentuser API pour obtenir les informations de base sur l'utilisateur actuellement connecté.
rapports API pour obtenir les détails des problèmes pour divers rapports.
version API pour obtenir la version du produit et les détails du client DAST.