Saltar al contenido principal
PATCH
Continuar la carga del escaneo

Autorizaciones

CORGEA-TOKEN
string
header
requerido

Clave de API para la autenticación Se rechazan los tokens de API de usuarios inactivos.

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

Identifica el cliente que inició el escaneo. Las solicitudes sin este encabezado se atribuyen a la API.

Opciones disponibles:
api,
cli,
vscode,
vs2022,
intellij
CORGEA-CLI-VERSION
string

Versión opcional de CLI registrada con el escaneo. Usa entre 1 y 64 letras, dígitos, puntos, signos más o guiones; los valores inválidos se ignoran.

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

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>
predeterminado:false

Envía true para un escaneo parcial o false para uno completo. Si se omite, se realiza un escaneo completo.

Opciones disponibles:
true,
false
files_to_scan
string

Rutas relativas al repositorio codificadas como una cadena con un array JSON, por ejemplo ["src/app.py","src/a,b.py"]. También se aceptan listas heredadas separadas por comas. Las rutas deben existir en el ZIP cargado, opcionalmente dentro de su carpeta contenedora. Se permite una lista vacía.

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.

incremental_ignore_rules
string

Cadena con un objeto JSON y arrays base y current de patrones de exclusión. Si se elimina una regla de exclusión de la base, incluye todos los archivos que deje de excluir en incremental_changed_files. Si se elimina una regla de la base sin conjuntos de reglas coincidentes, Corgea realiza un escaneo completo.

incremental_skipped_reason
string

Motivo de diagnóstico opcional para cargar sin un diff incremental. Usa entre 1 y 64 letras minúsculas, dígitos o guiones bajos. Los valores inválidos se ignoran; esto no desactiva el escaneo incremental del servidor.

incremental_skipped_detail
string

Detalle de diagnóstico opcional para incremental_skipped_reason, limitado a 2000 caracteres.

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.