スキャンリクエスト
スキャンリクエスト
目的
リクエストボディで指定されたオブジェクトのスキャン。
次のオブジェクトをスキャンできます:
パス
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 – 1 つのファイル
- multipart/form-data – 複数のファイル
- text/plain – 特定のリポジトリにある 1 つまたは複数の Docker イメージ
- application/json – 詳細設定の特定のリポジトリにある 1 つまたは複数の Docker イメージ
- x-api-key(オプション)
考えられるエラー
サポートされていない値が Content-Type ヘッダーに指定されている場合、次のエラーが返されます:
{
"error"={
"code"="NOT_SUPPORTED_CONTENT_TYPE",
"details"="<content type>",
"message"="Not supported Content-Type"
},
"status"="error"
}
この記事はお役に立ちましたか?
改善できる点がありましたらお聞かせください。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。