扫描请求

用途

扫描请求主体中指定的对象。

可以扫描以下对象：

• 一个文件
• 多个文件
• 位于特定存储库中的一个或多个 Docker 镜像
• 位于特定存储库中的一个或多个具有附加设置的 Docker 镜像

路径

http://<服务器>:<端口>/scans[?wait=1]

设置

可选的 wait 设置指定扫描会话的类型。

如果设置值为 1，则执行同步扫描，并且应用程序在扫描完成时发送报告。

如果设置值为 0，则执行异步扫描，响应如下：

{

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

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

}

其中：

• id – 扫描会话的唯一标识符。
• location – 用于请求有关此部分的信息的路径：http://<服务器>:<端口>/scans/<位置>。

请求标头

请求可以包含以下标头：

• Content-Type

  定义提交扫描的对象的类型。

  支持的值：

  • application/octet-stream – 一个文件
  • multipart/form-data – 多个文件
  • text/plain – 位于特定存储库中的一个或多个 Docker 镜像
  • application/json – 位于特定存储库中的一个或多个具有附加设置的 Docker 镜像
• x-api-key（可选）

  KRAS4D_XAPIKEY 环境变量中指定的 API 密钥或配置文件中的 xapikey 变量。

可能的错误

如果在 Content-Type 标头中指定了不受支持的值，应用程序将返回以下错误：

{

"error"={

"code"="NOT_SUPPORTED_CONTENT_TYPE",

"details"="<content type>",

"message"="Not supported Content-Type"

},

"status"="error"

}