ggshield icon indicating copy to clipboard operation
ggshield copied to clipboard

Scans Limit per month

Open nourafyz opened this issue 2 years ago • 1 comments

The 1K/month limitation on scan calls for the free account is causing ambiguity as I'm testing the solution on many projects. I tried running scans on multiple projects. It seems that I have reached the 1K limit, however I still get empty result file in json format. So I cannot distinguish between exceed quota and no issue found. Note that I use the following command in my code: ggshield secret scan --json -o {secretfile} path {path} -r -y

It would be great if the tool would produce a 'no scan performed' when I exceed the account's quota instead.

Another thing, I would appreciate knowing what constitute a 1 scan and counts toward the scan calls limit. Is it single call or number of repos/folder? It would help us manage tests better.

Thank you.

nourafyz avatar Jul 21 '22 20:07 nourafyz

Hi, reporting "quota exceeded" errors in the JSON output and at the end of the command is a good idea, I am going to add this to the next milestone.

Regarding quotas, you can learn more from https://docs.gitguardian.com/internal-repositories-monitoring/api/usage_and_quotas#quotas, but the doc might need some refresh because scanning large directories or repositories actually use more than one API call. I am going to look into getting this doc updated.

agateau-gg avatar Jul 25 '22 07:07 agateau-gg