Utilisation et quotas

Utilisation

L'API GitGuardian et sa capacité de scan peuvent être utilisées pour scanner rapidement du contenu simple, ou pour écrire des intégrations complexes pour des services non publics.

La plupart des projets open source de GitGuardian s'appuient sur l'API GitGuardian comme épine dorsale. ggshield et py-gitguardian en sont deux exemples.

Scan sans état (stateless)

Les endpoints de l'API GitGuardian sont sans état (stateless), ce qui signifie que les documents scannés et les secrets trouvés ne sont pas stockés sur nos serveurs lors d'un scan. Nous collectons et conservons toutefois certaines métadonnées pour des usages tels que le suivi des quotas et les journaux d'accès.

Quotas

Les quotas API ne sont consommés que par les appels API liés au scope scan :

• l'endpoint /scan ingère un seul document (morceau de texte) et consomme 1 quota.
• l'endpoint /multiscan ingère plusieurs documents à la fois (20 max) et consomme 1 quota.
  Si un commit contient 40 documents distincts à scanner, scanner ce commit nécessitera 2 quotas.

L'utilisation du quota est basée sur le nombre de requêtes, pas sur la taille du contenu scanné.

Le quota est calculé sur un mois glissant, et non sur un mois calendaire.
Cela signifie que si 200 appels API sont effectués le dernier jour du mois, vous devrez attendre 30 jours avant que ces 200 appels soient recrédités sur votre compte.
Ce quota est appliqué au niveau de l'espace de travail, pas au niveau de chaque clé API. Par conséquent, dépasser le quota avec une clé API empêchera toutes les autres clés API du même espace de travail d'effectuer de nouveaux appels.
Le quota dépend de votre plan, mais vous pouvez toujours nous contacter pour l'augmenter (voir la tarification GitGuardian pour plus de détails) :

	Plan Free	Plan Business	Plan Enterprise
Quota	10 000 appels/mois	100 000 appels/mois	Illimité

Les Managers de l'espace de travail peuvent suivre la consommation de leur quota dans la section Quota de leur espace de travail :

Limitation de débit (rate limiting)

L'API GitGuardian met en place une limitation de débit pour gérer le nombre de requêtes effectuées vers l'API.
Cela permet d'éviter les abus, d'assurer une utilisation équitable et de maintenir les performances et la disponibilité de l'API.

L'API GitGuardian applique la limitation de débit au niveau de la clé API, garantissant que chaque clé dispose d'un nombre maximal prédéfini de requêtes sur une fenêtre de temps donnée.
Si la limite est dépassée, l'API GitGuardian renverra une erreur avec le code de statut 429 et les requêtes ne seront pas traitées.
La limitation de débit varie selon le type de clé API (jeton d'accès personnel ou compte de service) et le plan de votre espace de travail :

	Plan Free	Plan Business	Plan Enterprise
Jeton d'accès personnel	50 requêtes/minute	200 requêtes/minute	2000 requêtes/minute
Compte de service	N/A Les comptes de service ne sont pas disponibles sur le plan Free	1000 requêtes/minute	10000 requêtes/minute

Par défaut, la limitation de débit de l'API n'est pas appliquée aux instances GitGuardian Self-Hosted.