Skip to main content
POST
Iniciar varredura de ingestão

Permissões

Requer um usuário de serviço ou um token de acesso pessoal com a permissão UseCodeScans no nível da organização.

Comportamento

Enfileira uma varredura de código no modo de ingestão. Em vez de identificar problemas do zero, uma varredura de ingestão recebe resultados produzidos externamente (por exemplo, um relatório SAST) e faz com que o Devin os faça a triagem e os valide no repositório. A varredura é iniciada de forma assíncrona pelo despachante de varreduras e atribuída ao principal que fez a chamada. O equivalente no escopo do Enterprise é Iniciar varredura de ingestão (Enterprise).

Campos da requisição

  • repo_name (obrigatório): nome completo do repositório, por exemplo, owner/repo.
  • profile_id (obrigatório): um perfil de varredura no modo ingest. Perfis no modo discover são rejeitados com 400.
  • host: host Git do repositório, caso não possa ser inferido.
  • attachment_urls: URLs de anexos do Devin (por exemplo, um relatório de scanner exportado) a serem fornecidas para a varredura. Primeiro, importe os arquivos usando a API de anexos, que exige a permissão UseDevinSessions.

Erros

  • 400 quando profile_id não é um perfil de modo de ingestão.
  • 404 quando o repositório ou perfil não está visível para a organização.
  • 409 quando o backlog de varredura da organização atingiu a capacidade máxima. Tente novamente mais tarde.

Autorizações

Authorization
string
header
obrigatório

Credencial de usuário de serviço (prefixo: cog_)

Parâmetros de caminho

org_id
string
obrigatório

ID da organização (prefixo: org-)

Exemplo:

"org-abc123def456"

Corpo

application/json

Corpo da requisição para iniciar uma varredura de código no modo de ingestão.

Aceita apenas um perfil de varredura no modo de ingestão (ingest-mode): o perfil é executado no repositório especificado.

profile_id
string
obrigatório

Perfil de varredura no modo de ingestão a ser executado. Deve ser um perfil de ingestão; perfis que não são de ingestão são rejeitados com 400.

repo_name
string
obrigatório

Nome completo do repositório para varredura.

attachment_urls
string<uri>[] | null

URLs de anexos do Devin a serem fornecidas à varredura, por exemplo, arquivos enviados pela API de anexos. Os anexos devem pertencer à organização analisada.

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

Host Git do repositório, se conhecido.

Resposta

Resposta bem-sucedida

Uma única varredura de código.

created_at
integer
obrigatório

Quando a varredura foi criada (segundos Unix).

host
string | null
obrigatório

Host Git do repositório, se conhecido.

org_id
string
obrigatório

Organização à qual a varredura pertence.

profile
CodeScanProfileResponse · object | null
obrigatório

Perfil sob o qual a varredura foi executada, se houver.

repo_name
string
obrigatório

Repositório principal da varredura. Varreduras com vários repositórios abrangem repositórios adicionais não listados aqui.

scan_id
string
obrigatório

Identificador único da varredura.

scan_type
enum<string>
obrigatório

Tipo de varredura, definido na criação.

Opções disponíveis:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
status
enum<string>
obrigatório

Status da varredura: waiting, pending, running, awaiting_user_input, completed, failed ou cancelled.

Opções disponíveis:
waiting,
pending,
running,
awaiting_user_input,
completed,
failed,
cancelled