Scans CodeCleared

Comprenez les scans CodeCleared liés à un commit, leurs types, crédits, statuts et attente API.

Objectif

Un scan évalue des contrôles choisis pour un commit de dépôt.

Pour qui

Les membres consultent les scans ; les intégrations autorisées peuvent les créer selon l’offre.

Prérequis

Utilisez un dépôt connecté et un hash de commit exact.

Fonctionnement

Lancez un scan, éventuellement limité à des types ou une unité, puis consultez son statut. Les clients API peuvent employer l’endpoint d’attente.

Règles métier

Les scans sont liés au commit. Les types consomment leur pool applicable après un preflight réussi (accès et entrées requises). Un 402 indique un manque de crédits ou de droit.

La préférence « dernier scan » gouvernance utilise sourceTrigger : cli (upload BYOT lockfile/SBOM) prime sur api | push | manual-ui, qui priment sur scheduled (pr-event exclu). Voir Gate CI CLI (BYOT).

Scénarios et cas limites

Attente expirée : conservez l’ID et relisez le statut. Scan partiel : vérifiez types et unité. Échec : consultez le statut (error / errorCode par unité) avant de dupliquer. Voir Échecs de scan.

Limites

L’attente API est bornée ; les flux longs doivent continuer à partir de l’ID du scan.

Erreurs courantes

Utiliser un nom de branche au lieu du hash.
Prendre un 402 pour un échec d’authentification.
Ignorer errorCode sur une unité en échec et relancer à l’aveugle.