Requête d'analyse (POST)

Fonction

Analyse d'un objet indiqué dans le corps de la requête.

L'analyse des objets suivants est prise en charge :

• un fichier ;
• plusieurs fichiers ;
• une ou plusieurs images Docker dans un référentiel donné ;
• une ou plusieurs images Docker dans un référentiel donné avec des paramètres avancés.

Chemin

http://<server>:<port>/scans[?wait=1]

Paramètres

Le paramètre obligatoire wait définit le type de session d'analyse.

Si le paramètre possède la valeur 1, alors l'analyse synchronisée a lieu et l'application envoie un rapport à la fin de l'analyse.

Si le paramètre possède la valeur 0, l'analyse réalisée est de type asynchrone et la réponse prend la forme suivante :

{

"id"="7d27e9b4-a4d7-469b-bdcf-ebfe953498e4",

"location"="/scans/7d27e9b4-a4d7-469b-bdcf-ebfe953498e4"

}

où :

• id représente l'identificateur unique de la session d'analyse ;
• location représente le chemin pour la requête d'information au sujet de cette section sous la forme http://<server>:<port>/scans/<location>.

En-têtes de requête

La requête peut contenir les en-têtes suivantes :

• Content-Type

  Définit le type d'objet soumis à l'analyse.

  Valeurs acceptées :

  • application/octet-stream : un fichier ;
  • multipart/form-data : plusieurs fichiers ;
  • text/plain : une ou plusieurs images Docker dans un référentiel donné ;
  • application/json : une ou plusieurs images Docker dans un référentiel donné avec des paramètres avancés.
• x-api-key (facultatif)

  Clé API définie dans la variable d'environnement KRAS4D_XAPIKEY ou la variable xapikey du fichier de configuration.

Erreurs possibles

Si l'en-tête Content-Type contient une valeur qui n'est pas prise en charge, l'application renvoie une erreur comme suit :

{

"error"={

"code"="NOT_SUPPORTED_CONTENT_TYPE",

"details"="<content type>",

"message"="Not supported Content-Type"

},

"status"="error"

}