Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scans Limit per month #309

Closed
nourafyz opened this issue Jul 21, 2022 · 1 comment · Fixed by #610
Closed

Scans Limit per month #309

nourafyz opened this issue Jul 21, 2022 · 1 comment · Fixed by #610
Labels
type:feature Feature request
Milestone

Comments

@nourafyz
Copy link

nourafyz commented Jul 21, 2022

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 nourafyz added the type:feature Feature request label Jul 21, 2022
@agateau-gg
Copy link
Collaborator

agateau-gg commented Jul 25, 2022

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 agateau-gg added this to the 1.14.0 milestone Jul 25, 2022
Walz added a commit that referenced this issue Jul 5, 2023
When quota limit is reached ggshield:
 - prints this error: "Could not perform the requested action: no more API calls available."
 - exits with an error code of 128
 - does not print anything through the output handlers (no text report, no JSON report)
Walz added a commit that referenced this issue Jul 5, 2023
When quota limit is reached ggshield:
 - prints this error: "Could not perform the requested action: no more API calls available."
 - exits with an error code of 128
 - does not print anything through the output handlers (no text report, no JSON report)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature Feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants