Запрос на проверку (POST)

Назначение

Проверка объекта, указанного в теле запроса.

Предусмотрена проверка следующих объектов:

• одного файла;
• нескольких файлов;
• Docker-образа или нескольких Docker-образов, расположенных в определенном репозитории;
• Docker-образ или несколько Docker-образов, расположенных в определенном репозитории, с указанием дополнительных параметров.

Путь

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

Параметры

Необязательный параметр wait задает тип сессии проверки.

Если параметру присвоено значение 1, то выполняется синхронная проверка и приложение присылает отчет после окончания проверки.

Если параметру присвоено значение 0, то выполняется асинхронная проверка, а ответ будет иметь вид:

{

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

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

}

где:

• id – уникальный идентификатор сессии проверки;
• location – путь для запроса информации по этой секции вида http://<server>:<port>/scans/<location>.

Заголовки запроса

Запрос может содержать следующие заголовки:

• Content-Type

  Определяет тип объекта, который передается на проверку.

  Поддерживаемые значения:

  • application/octet-stream – один файл;
  • multipart/form-data – несколько файлов;
  • text/plain – Docker-образ или несколько Docker-образов, расположенных в определенном репозитории;
  • application/json – Docker-образ или несколько Docker-образов, расположенных в определенном репозитории, с указанием дополнительных параметров.
• x-api-key (необязательный)

  API-ключ, заданный в переменной окружения KRAS4D_XAPIKEY или переменной xapikey конфигурационного файла.

Возможные ошибки

Если в заголовке Content-Type указано неподдерживаемое значение, приложение вернет ошибку следующего вида:

{

"error"={

"code"="NOT_SUPPORTED_CONTENT_TYPE",

"details"="<content type>",

"message"="Not supported Content-Type"

},

"status"="error"

}