Skip to main content
POST
Iniciar varredura de código

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 nova varredura de código para repo_name na organização. A varredura é iniciada de forma assíncrona pelo despachante de varreduras; a resposta é o registro da varredura, com status inicial waiting ou pending. Consulte List Code Scans para acompanhar o progresso e List Code Scan Findings (filtrada por scan_id) para ler os resultados quando a varredura atingir completed. A varredura é atribuída ao principal que fez a chamada (o usuário de serviço ou PAT que fez a requisição). O equivalente no escopo Enterprise é Iniciar varredura de código (Enterprise).

Campos da requisição

  • repo_name (obrigatório): nome completo do repositório, por exemplo, owner/repo. O repositório já deve estar acessível pela integração Git da organização.
  • host: host Git do repositório, caso não possa ser inferido.
  • profile_id: um perfil de varredura a ser aplicado. Use Iniciar varredura de ingestão para perfis no modo ingest.
  • scan_type: tipo de varredura a ser executada. Deve corresponder ao tipo de varredura do perfil quando profile_id for informado. Por padrão, usa o tipo do perfil ou security para varreduras sem perfil. Tipos de varredura que não são de segurança exigem um perfil.
  • commit_sha: commit a ser usado antes da varredura. Por padrão, usa o commit mais recente da branch padrão do repositório.

Erros

  • 400 quando scan_type conflita com o perfil ou quando um scan_type diferente de Security é fornecido sem um perfil.
  • 403 quando a organização está restrita a varreduras somente de ingestion e nenhum perfil no modo ingest é fornecido.
  • 404 quando o repositório ou o perfil não está visível para a organização.
  • 409 quando o backlog de varreduras da organização atinge 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 nova varredura de código.

repo_name
string
obrigatório

Nome completo do repositório a ser varrido.

commit_sha
string | null

Commit para fazer checkout antes da varredura.

host
string | null

Host Git do repositório, se conhecido.

profile_id
string | null

Perfil de varredura a ser aplicado à varredura.

scan_type
enum<string> | null

Tipo de varredura a executar. Deve corresponder ao tipo de varredura do perfil quando um perfil é fornecido; por padrão, usa o tipo do perfil ou 'security' para varreduras sem perfil. Tipos que não são de segurança exigem um perfil e são rejeitados sem um.

Opções disponíveis:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs

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