Skip to main content
POST
Iniciar análisis de ingesta

Permisos

Requiere un usuario de servicio o un token de acceso personal con el permiso UseCodeScans a nivel de organización.

Comportamiento

Pone en cola un análisis de código en modo de ingesta. En lugar de detectar problemas desde cero, un análisis de ingesta utiliza hallazgos generados en otro lugar (por ejemplo, un informe SAST) y hace que Devin los clasifique y valide en el repositorio. El análisis se inicia de forma asíncrona mediante el distribuidor de análisis y se atribuye al principal que realiza la llamada. El equivalente en el ámbito de Enterprise es Iniciar análisis de ingesta (Enterprise).

Campos de la solicitud

  • repo_name (obligatorio): nombre completo del repositorio; por ejemplo, owner/repo.
  • profile_id (obligatorio): un perfil de escaneo en modo ingest. Se rechazarán con 400 los perfiles en modo discover.
  • host: host de Git del repositorio, si no puede inferirse.
  • attachment_urls: URL de archivos adjuntos de Devin (por ejemplo, un informe exportado de un escáner) que se proporcionarán al escaneo. Primero, sube los archivos mediante la API de archivos adjuntos, que requiere el permiso UseDevinSessions.

Errores

  • 400 cuando profile_id no corresponde a un perfil en modo de ingesta.
  • 404 cuando el repositorio o el perfil no es visible para la organización.
  • 409 cuando el backlog de escaneos de la organización ha alcanzado su capacidad máxima. Vuelve a intentarlo más tarde.

Autorizaciones

Authorization
string
header
requerido

Credencial de usuario de servicio (prefijo: cog_)

Parámetros de ruta

org_id
string
requerido

ID de la organización (prefijo: org-)

Ejemplo:

"org-abc123def456"

Cuerpo

application/json

Cuerpo de la solicitud para iniciar un análisis de código en modo de ingesta.

Solo se acepta un perfil de análisis de ingesta (modo de ingesta): el perfil se ejecuta en el repositorio especificado.

profile_id
string
requerido

Perfil de análisis en modo de ingesta que se ejecutará. Debe ser un perfil de ingesta; los perfiles que no son de ingesta se rechazan con 400.

repo_name
string
requerido

Nombre completo del repositorio que se analizará.

attachment_urls
string<uri>[] | null

URL de archivos adjuntos de Devin que se proporcionarán al análisis, p. ej., archivos subidos mediante la API de archivos adjuntos. Los archivos adjuntos deben pertenecer a la organización que se analiza.

Maximum array length: 10
Required string length: 1 - 2083
host
string | null

Servidor Git del repositorio, si se conoce.

Respuesta

Respuesta satisfactoria

Un análisis de código individual.

created_at
integer
requerido

Momento en que se creó el análisis (segundos Unix).

host
string | null
requerido

Host de Git del repositorio, si se conoce.

org_id
string
requerido

Organización a la que pertenece el análisis.

profile
CodeScanProfileResponse · object | null
requerido

Perfil con el que se ejecutó el análisis, si corresponde.

repo_name
string
requerido

Repositorio principal del análisis. Los análisis de varios repositorios abarcan repositorios adicionales que no se enumeran aquí.

scan_id
string
requerido

Identificador único del análisis.

scan_type
enum<string>
requerido

Tipo de análisis, establecido al crearlo.

Opciones disponibles:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
status
enum<string>
requerido

Estado del análisis: waiting, pending, running, awaiting_user_input, completed, failed o cancelled.

Opciones disponibles:
waiting,
pending,
running,
awaiting_user_input,
completed,
failed,
cancelled