curl --request PATCH \
--url https://www.corgea.app/api/v1/start-scan/{transfer_id}/ \
--header 'CORGEA-TOKEN: <api-key>' \
--header 'Content-Type: multipart/form-data' \
--header 'Upload-Length: <upload-length>' \
--header 'Upload-Name: <upload-name>' \
--header 'Upload-Offset: <upload-offset>' \
--form chunk_data='@example-file' \
--form 'project_name=<string>' \
--form 'branch=<string>' \
--form 'repo_url=<string>' \
--form 'sha=<string>' \
--form partial_scan=true \
--form 'files_to_scan=<string>' \
--form 'metadata=<string>' \
--form 'scan_configs=<string>' \
--form 'target_policies=<string>'import requests
url = "https://www.corgea.app/api/v1/start-scan/{transfer_id}/"
files = { "chunk_data": ("example-file", open("example-file", "rb")) }
payload = {
"project_name": "<string>",
"branch": "<string>",
"repo_url": "<string>",
"sha": "<string>",
"partial_scan": "true",
"files_to_scan": "<string>",
"metadata": "<string>",
"scan_configs": "<string>",
"target_policies": "<string>"
}
headers = {
"Upload-Offset": "<upload-offset>",
"Upload-Length": "<upload-length>",
"Upload-Name": "<upload-name>",
"CORGEA-TOKEN": "<api-key>"
}
response = requests.patch(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('chunk_data', '<string>');
form.append('project_name', '<string>');
form.append('branch', '<string>');
form.append('repo_url', '<string>');
form.append('sha', '<string>');
form.append('partial_scan', 'true');
form.append('files_to_scan', '<string>');
form.append('metadata', '<string>');
form.append('scan_configs', '<string>');
form.append('target_policies', '<string>');
const options = {
method: 'PATCH',
headers: {
'Upload-Offset': '<upload-offset>',
'Upload-Length': '<upload-length>',
'Upload-Name': '<upload-name>',
'CORGEA-TOKEN': '<api-key>'
}
};
options.body = form;
fetch('https://www.corgea.app/api/v1/start-scan/{transfer_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.corgea.app/api/v1/start-scan/{transfer_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunk_data\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"project_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"branch\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"repo_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sha\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"partial_scan\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files_to_scan\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scan_configs\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_policies\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"CORGEA-TOKEN: <api-key>",
"Content-Type: multipart/form-data",
"Upload-Length: <upload-length>",
"Upload-Name: <upload-name>",
"Upload-Offset: <upload-offset>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.corgea.app/api/v1/start-scan/{transfer_id}/"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunk_data\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"project_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"branch\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"repo_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sha\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"partial_scan\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files_to_scan\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scan_configs\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_policies\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Upload-Offset", "<upload-offset>")
req.Header.Add("Upload-Length", "<upload-length>")
req.Header.Add("Upload-Name", "<upload-name>")
req.Header.Add("CORGEA-TOKEN", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://www.corgea.app/api/v1/start-scan/{transfer_id}/")
.header("Upload-Offset", "<upload-offset>")
.header("Upload-Length", "<upload-length>")
.header("Upload-Name", "<upload-name>")
.header("CORGEA-TOKEN", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunk_data\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"project_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"branch\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"repo_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sha\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"partial_scan\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files_to_scan\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scan_configs\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_policies\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.corgea.app/api/v1/start-scan/{transfer_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Upload-Offset"] = '<upload-offset>'
request["Upload-Length"] = '<upload-length>'
request["Upload-Name"] = '<upload-name>'
request["CORGEA-TOKEN"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunk_data\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"project_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"branch\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"repo_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sha\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"partial_scan\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files_to_scan\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scan_configs\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_policies\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status": "ok",
"message": "Chunk received."
}スキャンのアップロードを継続
BLASTのチャンクアップロードを継続します。このパスには末尾のスラッシュが必要です。途中のレスポンスには Upload-Offset ヘッダーがあり、scan_id はありません。最後のチャンクでアーカイブが揃うと、JSON本文に scan_id と project_id が含まれ、Upload-Offset は設定されません。
curl --request PATCH \
--url https://www.corgea.app/api/v1/start-scan/{transfer_id}/ \
--header 'CORGEA-TOKEN: <api-key>' \
--header 'Content-Type: multipart/form-data' \
--header 'Upload-Length: <upload-length>' \
--header 'Upload-Name: <upload-name>' \
--header 'Upload-Offset: <upload-offset>' \
--form chunk_data='@example-file' \
--form 'project_name=<string>' \
--form 'branch=<string>' \
--form 'repo_url=<string>' \
--form 'sha=<string>' \
--form partial_scan=true \
--form 'files_to_scan=<string>' \
--form 'metadata=<string>' \
--form 'scan_configs=<string>' \
--form 'target_policies=<string>'import requests
url = "https://www.corgea.app/api/v1/start-scan/{transfer_id}/"
files = { "chunk_data": ("example-file", open("example-file", "rb")) }
payload = {
"project_name": "<string>",
"branch": "<string>",
"repo_url": "<string>",
"sha": "<string>",
"partial_scan": "true",
"files_to_scan": "<string>",
"metadata": "<string>",
"scan_configs": "<string>",
"target_policies": "<string>"
}
headers = {
"Upload-Offset": "<upload-offset>",
"Upload-Length": "<upload-length>",
"Upload-Name": "<upload-name>",
"CORGEA-TOKEN": "<api-key>"
}
response = requests.patch(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('chunk_data', '<string>');
form.append('project_name', '<string>');
form.append('branch', '<string>');
form.append('repo_url', '<string>');
form.append('sha', '<string>');
form.append('partial_scan', 'true');
form.append('files_to_scan', '<string>');
form.append('metadata', '<string>');
form.append('scan_configs', '<string>');
form.append('target_policies', '<string>');
const options = {
method: 'PATCH',
headers: {
'Upload-Offset': '<upload-offset>',
'Upload-Length': '<upload-length>',
'Upload-Name': '<upload-name>',
'CORGEA-TOKEN': '<api-key>'
}
};
options.body = form;
fetch('https://www.corgea.app/api/v1/start-scan/{transfer_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.corgea.app/api/v1/start-scan/{transfer_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunk_data\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"project_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"branch\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"repo_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sha\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"partial_scan\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files_to_scan\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scan_configs\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_policies\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"CORGEA-TOKEN: <api-key>",
"Content-Type: multipart/form-data",
"Upload-Length: <upload-length>",
"Upload-Name: <upload-name>",
"Upload-Offset: <upload-offset>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.corgea.app/api/v1/start-scan/{transfer_id}/"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunk_data\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"project_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"branch\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"repo_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sha\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"partial_scan\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files_to_scan\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scan_configs\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_policies\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Upload-Offset", "<upload-offset>")
req.Header.Add("Upload-Length", "<upload-length>")
req.Header.Add("Upload-Name", "<upload-name>")
req.Header.Add("CORGEA-TOKEN", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://www.corgea.app/api/v1/start-scan/{transfer_id}/")
.header("Upload-Offset", "<upload-offset>")
.header("Upload-Length", "<upload-length>")
.header("Upload-Name", "<upload-name>")
.header("CORGEA-TOKEN", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunk_data\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"project_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"branch\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"repo_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sha\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"partial_scan\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files_to_scan\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scan_configs\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_policies\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.corgea.app/api/v1/start-scan/{transfer_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Upload-Offset"] = '<upload-offset>'
request["Upload-Length"] = '<upload-length>'
request["Upload-Name"] = '<upload-name>'
request["CORGEA-TOKEN"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"chunk_data\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"project_name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"branch\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"repo_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sha\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"partial_scan\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files_to_scan\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"scan_configs\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_policies\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status": "ok",
"message": "Chunk received."
}承認
認証用のAPIキー
ヘッダー
アップロードの現在のバイトオフセット
ファイルの合計サイズ(バイト)
アップロード中のファイル名
Identifies the client that triggered the scan. Requests without this header are attributed to the API.
api, cli, vscode, vs2022, intellij パスパラメータ
最初のスキャンリクエストで返された転送ID
ボディ
スキャン用データの次のチャンク
フルスキャンではこのフィールドを省略します。部分スキャンのときだけ true を送ります。APIは空でないフォーム値をすべて部分スキャンとして扱い、文字列 false も含まれます。
true スキャン対象ファイルの一覧(カンマ区切り)
ユーザー指定のスキャンメタデータをJSONオブジェクト文字列として渡します(例: {"pipeline_url":"https://ci.example/run/123"})。チャンクリクエストごとに検証され、アップロード完了時にスキャンへ関連付けられます。16,384バイト以下のJSONオブジェクトである必要があり、それ以外の場合はリクエストが400で失敗します。
アップロードしたワークツリーが dirty かどうか。CLI はリポジトリ情報があるとき true または false を送ります。不明な場合はこのフィールドを省略します。
true, false アップロード完了時に適用するスキャン種別トークンのカンマ区切り(base、malicious、policy、secrets、pii など)。CLI は --scan-type blast を base に変換します。省略時はサーバー既定値です。
アップロード完了時に適用するポリシー ID のカンマ区切り。無効な ID は 400 を返します。
このページは役に立ちましたか?
