Saltar al contenido principal
GET
Obtener escaneo

Autorizaciones

CORGEA-TOKEN
string
header
requerido

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

Parámetros de ruta

scan_id
string<uuid>
requerido

ID del escaneo

Respuesta

Detalles del escaneo obtenidos correctamente

id
string<uuid>
project
string
repo
string
branch
string
status
enum<string>

Progreso del escaneo. "scanning" y "processing" son estados en curso, "complete" indica que el escaneo ha terminado e "incomplete" indica que ha fallado.

Opciones disponibles:
scanning,
processing,
complete,
incomplete
engine
string
created_at
string<date-time>
time_taken
number | null

Duración del escaneo en segundos, o null hasta que termine de procesarse

git_sha
string | null

SHA del commit asociado al escaneo

worktree_dirty
boolean | null

Indica si el escaneo incluyó cambios locales sin confirmar. Es null en los escaneos creados sin información sobre el estado del worktree.

metadata
object | null

Metadatos proporcionados por el usuario y asociados al escaneo

source
enum<string> | null

Indica cómo se inició el escaneo; null si se desconoce su origen.

Opciones disponibles:
api,
cli,
vscode,
vs2022,
intellij,
github_app,
gitlab,
azure_devops,
bitbucket,
harness,
scheduled,
manual,
demo,
web_upload,
other,
null
triggered_by
object | null

Usuario que inició el escaneo. Es null para escaneos de integraciones de control de código fuente; no representa al autor del pull request. El correo se puede usar con el filtro triggered_by.

pull_request_id
string | null

Identificador del pull request o merge request; null para escaneos sin uno.