メインコンテンツへスキップ
PATCH
スキャンのアップロードを継続

承認

CORGEA-TOKEN
string
header
必須

認証用のAPIキー 無効なユーザーのAPIトークンは拒否されます。

ヘッダー

Upload-Offset
integer
必須

アップロードの現在のバイトオフセット

Upload-Length
integer
必須

ファイルの合計サイズ(バイト)

Upload-Name
string
必須

アップロード中のファイル名

CORGEA-SOURCE
enum<string>
デフォルト:api

スキャンを開始したクライアントを識別します。このヘッダーがないリクエストはAPIからのものとして扱われます。

利用可能なオプション:
api,
cli,
vscode,
vs2022,
intellij
CORGEA-CLI-VERSION
string

スキャンとともに記録する任意のCLIバージョン。1~64文字の英数字、ピリオド、プラス記号、ハイフンを使用します。無効な値は無視されます。

Maximum string length: 64
Pattern: ^[0-9A-Za-z.+-]{1,64}$

パスパラメータ

transfer_id
string<uuid>
必須

最初のスキャンリクエストで返された転送ID

ボディ

multipart/form-data
chunk_data
file
必須

スキャン用データの次のチャンク

project_name
string
branch
string
repo_url
string
sha
string
partial_scan
enum<string>
デフォルト:false

部分スキャンにはtrue、フルスキャンにはfalseを指定します。省略時はフルスキャンを実行します。

利用可能なオプション:
true,
false
files_to_scan
string

リポジトリを基準とする相対パスをJSON配列の文字列で指定します。例:["src/app.py","src/a,b.py"]。従来のカンマ区切りの一覧も使用できます。パスはアップロードしたZIP内に存在する必要があり、全体を囲むフォルダー内のパスも指定できます。空の一覧も使用できます。

dirty
enum<string>

アップロードしたワークツリーが dirty かどうか。CLI はリポジトリ情報があるとき true または false を送ります。不明な場合はこのフィールドを省略します。

利用可能なオプション:
true,
false
scan_configs
string

アップロード完了時に適用するスキャン種別トークンのカンマ区切り(base、malicious、policy、secrets、pii など)。CLI は --scan-type blast を base に変換します。省略時はサーバー既定値です。

target_policies
string

アップロード完了時に適用するポリシー ID のカンマ区切り。無効な ID は 400 を返します。

incremental_ignore_rules
string

除外パターンの配列baseとcurrentを含むJSONオブジェクトの文字列。基準スキャンの除外ルールを解除した場合、新たに対象となるすべてのファイルをincremental_changed_filesに含めます。基準スキャンのルールを解除し、ルールの組み合わせが一致しない場合、Corgeaはフルスキャンを実行します。

incremental_skipped_reason
string

差分なしでアップロードした理由を記録する任意の診断情報。1~64文字の英小文字、数字、アンダースコアを使用します。無効な値は無視され、サーバー側の増分スキャンは無効になりません。

incremental_skipped_detail
string

incremental_skipped_reasonの任意の診断詳細。最大2,000文字です。

レスポンス

チャンクを受け付けました。途中のレスポンスは Upload-Offset を返します。完了時および既に進行中のスキャンのレスポンスでは返しません。

status
enum<string>
必須
利用可能なオプション:
ok
例:

"ok"

message
string
必須
scan_id
string<uuid>

最後のチャンクでアーカイブが揃い、スキャンが開始されたときに含まれます。

例:

"1a5afaa3-72ac-458f-a492-ac40ffc88e76"

project_id
integer

スキャン開始時に scan_id と一緒に含まれます。