Skip to main content
PATCH
Continuar la carga del escaneo

Autorizaciones

CORGEA-TOKEN
string
header
requerido

Clave de API para la autenticación

Encabezados

Upload-Offset
integer
requerido

Offset actual de la carga, en bytes

Upload-Length
integer
requerido

Tamaño total del archivo en bytes

Upload-Name
string
requerido

Nombre del archivo que se está cargando

CORGEA-SOURCE
enum<string>
predeterminado:api

Identifies the client that triggered the scan. Requests without this header are attributed to the API.

Opciones disponibles:
api,
cli,
vscode,
vs2022,
intellij

Parámetros de ruta

transfer_id
string<uuid>
requerido

ID de transferencia de la solicitud inicial del escaneo

Cuerpo

multipart/form-data
chunk_data
file
requerido

Siguiente fragmento de datos del escaneo

project_name
string
branch
string
repo_url
string
sha
string
partial_scan
enum<string>

Omite este campo para un escaneo completo. Envía true solo para un escaneo parcial. La API trata cualquier valor de formulario no vacío como escaneo parcial, incluida la cadena false.

Opciones disponibles:
true
files_to_scan
string

Lista de archivos que se deben escanear, separados por comas

metadata
string

Metadatos del escaneo proporcionados por el usuario como cadena de objeto JSON, p. ej., {"pipeline_url":"https://ci.example/run/123"}. Se validan en cada solicitud de fragmento y se asocian al escaneo cuando se completa la carga. Deben ser un objeto JSON de 16.384 bytes como máximo; de lo contrario, la solicitud falla con el código 400.

dirty
enum<string>

Si el worktree subido está dirty. La CLI envía true o false cuando tiene datos del repositorio. Omite el campo si el estado es desconocido.

Opciones disponibles:
true,
false
scan_configs
string

Tokens de tipo de escaneo separados por comas, aplicados al completar la carga (base, malicious, policy, secrets, pii y otros). La CLI asigna --scan-type blast a base. Omite para los valores predeterminados del servidor.

target_policies
string

IDs de políticas separados por comas, aplicados al completar la carga. Los IDs no válidos devuelven 400.

Respuesta

Fragmento aceptado. Las respuestas intermedias establecen Upload-Offset. Las respuestas de finalización y de escaneo ya en curso no lo hacen.

status
enum<string>
requerido
Opciones disponibles:
ok
Ejemplo:

"ok"

message
string
requerido
scan_id
string<uuid>

Presente cuando el último fragmento completa el archivo y se inicia un escaneo.

Ejemplo:

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

project_id
integer

Presente junto con scan_id cuando se inicia un escaneo.