Skip to main content
PATCH
/
start-scan
/
{transfer_id}
Continue Scan Upload
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 'project_name=<string>' \
  --form 'branch=<string>' \
  --form 'repo_url=<string>' \
  --form 'sha=<string>' \
  --form partial_scan=true \
  --form 'files_to_scan=<string>' \
  --form chunk_data=@example-file
{
  "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "success",
  "message": "Chunk uploaded successfully."
}

Authorizations

​
CORGEA-TOKEN
string
header
required

API key for authentication

Headers

​
Upload-Offset
integer
required

Current byte offset of the upload

​
Upload-Length
integer
required

Total size of the file in bytes

​
Upload-Name
string
required

Name of the file being uploaded

Path Parameters

​
transfer_id
string<uuid>
required

The transfer ID from the initial scan request

Body

multipart/form-data
​
chunk_data
file
required

The next chunk of data for the scan

​
project_name
string
​
branch
string
​
repo_url
string
​
sha
string
​
partial_scan
boolean
​
files_to_scan
string

Comma-separated list of files to scan

Response

Chunk uploaded successfully

  • Option 1
  • Option 2
​
transfer_id
string<uuid>
​
status
string
Example:

"success"

​
message
string
Example:

"Chunk uploaded successfully."

⌘I