Skip to main content
GET
Obtener perfil de análisis de código

Permisos

Requiere un usuario de servicio o un token de acceso personal con el permiso ViewAccountCodeScans en el nivel Enterprise.

Comportamiento

Devuelve los metadatos del perfil, su visibilidad (propiedad de la organización o compartido en toda la cuenta), los patrones glob de inclusión/exclusión y todos los campos de instrucción (para investigación, comunicación y origen de ingesta). Devuelve 404 si el perfil no existe o no es visible para la cuenta Enterprise. El equivalente en el ámbito de la organización es Obtener perfil de análisis de código (organización).

Autorizaciones

Authorization
string
header
requerido

Credencial de usuario de servicio (prefijo: cog_)

Parámetros de ruta

profile_id
string
requerido

Respuesta

Respuesta satisfactoria

Detalles completos de un perfil de análisis de código, incluidas sus instrucciones.

created_at
integer
requerido

Cuándo se creó el perfil (segundos Unix).

description
string | null
requerido

Descripción del perfil, si existe.

exclude_globs
string[] | null
requerido

Patrones glob de archivos que se excluirán del análisis, si existen.

include_globs
string[] | null
requerido

Patrones glob de archivos que se incluirán en el análisis, si existen.

ingestion_source_guidance
string | null
requerido

Instrucciones que describen el origen de la ingesta, si existen.

investigation_guidance
string | null
requerido

Instrucciones para la fase de investigación, si existen.

mode
enum<string>
requerido

Modo del perfil: discover o ingest.

Opciones disponibles:
discover,
ingest
name
string
requerido

Nombre del perfil.

org_id
string | null
requerido

Organización propietaria del perfil. Null cuando el perfil se comparte en toda la cuenta.

post_ingestion_guidance
string | null
requerido

Instrucciones para la fase posterior a la ingesta, si existen.

profile_id
string
requerido

Identificador único del perfil.

remediation_guidance
string | null
requerido

Instrucciones para la fase de remediación, si existen.

report_guidance
string | null
requerido

Instrucciones para la fase de generación de informes, si existen.

scan_type
enum<string>
requerido

Tipo de análisis que configura el perfil.

Opciones disponibles:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
threat_model_guidance
string | null
requerido

Guía que describe el modelo de amenazas, si corresponde.

triage_guidance
string | null
requerido

Guía para la fase de triaje, si corresponde.

validation_guidance
string | null
requerido

Guía para la fase de validación, si corresponde.

visibility
enum<string>
requerido

Indica si el perfil pertenece a una sola organización o si se comparte en toda la cuenta.

Opciones disponibles:
org,
account
communication_guidance
string | null

Directrices para la fase de comunicación (actuar sobre los hallazgos finales, p. ej., notificar a responsables o partes interesadas), si las hubiera.