Untersuchungsanforderung (POST)
Ziel
Untersuchung des Objekts, das im Textkörper der Anforderung angegeben ist
Die Untersuchung ist für folgende Objekte vorgesehen:
- eine Datei
- mehrere Dateien
- Docker-Image oder mehrere Docker-Images in einem bestimmten Repository
- Docker-Image oder mehrere Docker-Images in einem bestimmten Repository mit Angabe zusätzlicher Einstellungen
Pfad
http://<server>:<port>/scans[?wait=1]
Einstellungen
Die optionale Einstellung wait
gibt den Typ der Untersuchungssitzung an.
Wenn die Einstellung den Wert 1
besitzt, wird eine synchrone Untersuchung durchgeführt und die App versendet nach Beendigung der Untersuchung einen Bericht.
Wenn die Einstellung den Wert 0
besitzt, wird eine asynchrone Untersuchung durchgeführt und die Antwort sieht wie folgt aus:
{
"id"="7d27e9b4-a4d7-469b-bdcf-ebfe953498e4",
"location"="/scans/7d27e9b4-a4d7-469b-bdcf-ebfe953498e4"
}
Wobei gilt:
- id – Eindeutige ID der Untersuchungssitzung
- location – Pfad zur Anforderung von Informationen zu diesem Abschnitt vom Typ http://<server>:<port>/scans/<location>
Header der Anforderung
Die Anforderung kann die folgenden Header enthalten:
- Content-Type
Definiert den Objekttyp, der zur Untersuchung übergeben wird.
Unterstützte Werte:
- application/octet-stream – eine Datei
- multipart/form-data – mehrere Dateien
- text/plain – Docker-Image oder mehrere Docker-Images in einem bestimmten Repository
- application/json – Docker-Image oder mehrere Docker-Images in einem bestimmten Repository mit Angabe zusätzlicher Einstellungen
- x-api-key (optional)
API-Schlüssel, wie in der Umgebungsvariablen KRAS4D_XAPIKEY oder der Variablen "xapikey" in der Konfigurationsdatei angegeben
Mögliche Fehler
Wenn im Header "Content-Type" ein nicht unterstützter Wert angegeben wird, gibt die App einen Fehler des folgenden Typs zurück:
{
"error"={
"code"="NOT_SUPPORTED_CONTENT_TYPE",
"details"="<content type>",
"message"="Not supported Content-Type"
},
"status"="error"
}