Skip to main content
GET
Obter perfil de varredura de código

Permissões

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

Comportamento

Retorna os metadados do perfil, a visibilidade (pertencente à organização ou compartilhado em nível da conta), os padrões glob de inclusão/exclusão e todos os campos de orientação (investigação, comunicação e origem da ingestão). Retorna 404 quando o perfil não existe ou não está visível para a conta Enterprise. O equivalente com escopo de organização é Obter perfil de varredura de código (Organização).

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

profile_id
string
obrigatório

Resposta

Resposta bem-sucedida

Detalhes completos de um perfil de varredura de código, incluindo suas orientações.

created_at
integer
obrigatório

Momento em que o perfil foi criado (segundos Unix).

description
string | null
obrigatório

Descrição do perfil, se houver.

exclude_globs
string[] | null
obrigatório

Padrões glob de arquivos a excluir da varredura, se houver.

include_globs
string[] | null
obrigatório

Padrões glob de arquivos a incluir na varredura, se houver.

ingestion_source_guidance
string | null
obrigatório

Orientações que descrevem a origem da ingestão, se houver.

investigation_guidance
string | null
obrigatório

Orientações para a fase de investigação, se houver.

mode
enum<string>
obrigatório

Modo do perfil: discover ou ingest.

Opções disponíveis:
discover,
ingest
name
string
obrigatório

Nome do perfil.

org_id
string | null
obrigatório

Organização proprietária do perfil. Null quando o perfil é compartilhado em nível da conta.

post_ingestion_guidance
string | null
obrigatório

Orientações para a fase pós-ingestão, se houver.

profile_id
string
obrigatório

Identificador exclusivo do perfil.

remediation_guidance
string | null
obrigatório

Orientações para a fase de remediação, se houver.

report_guidance
string | null
obrigatório

Orientações para a fase de relatório, se houver.

scan_type
enum<string>
obrigatório

Tipo de varredura que o perfil configura.

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

Orientação que descreve o modelo de ameaças, se houver.

triage_guidance
string | null
obrigatório

Orientação para a fase de triagem, se houver.

validation_guidance
string | null
obrigatório

Orientação para a fase de validação, se houver.

visibility
enum<string>
obrigatório

Indica se o perfil pertence a uma única organização ou se é compartilhado em toda a conta.

Opções disponíveis:
org,
account
communication_guidance
string | null

Orientação para a fase de comunicação (ações sobre os resultados finais, por exemplo, notificar responsáveis ou partes interessadas), se houver.