Skip to content

Commit af56afa

Browse files
committed
Add throttling info in docs
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
1 parent 9203c39 commit af56afa

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

vulnerablecode/settings.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -275,19 +275,25 @@
275275
<p><strong>VulnerableCode</strong> is open data and free software by
276276
<a href="https://github.com/nexB/vulnerablecode"> nexB Inc. and others.</a>
277277
</p>
278+
<p>API is throttled for anon users it is 10/minute and 30/minute for user with API key </p>
279+
<p>Please refer to https://urllib3.readthedocs.io/en/stable/reference/urllib3.util.html and set <code> respect_retry_after_header </code> as True to respect the Retry-After header.</p>
280+
<p>Example: https://github.com/aboutcode-org/dejacode/pull/550/changes#diff-9065d35748dfe1659a740cce66f00cee2782e07016665739584799bd27489df3 </p>
278281
<p>The VulnerableCode API exposes these endpoints:</p>
279282
<ul>
280283
<li>
281-
<strong>packages/</strong>: main endpoint to lookup for vulnerable packages.
284+
<strong>/v3/packages/</strong>: main endpoint to lookup for vulnerable packages.
282285
</li>
283286
<li>
284-
<strong>vulnerabilities/</strong>: secondary endpoint to lookup by vulnerabilities.
287+
<strong>/v3/advisories/</strong>: endpoint to lookup for advisories for a given package.
285288
</li>
286289
<li>
287-
<strong>alias/</strong>: secondary endpoint to lookup vulnerabilities by aliases (e.g., CVE)
290+
<strong>/v3/affected-by-advisories/</strong>: endpoint to lookup for advisories that affect a given package.
288291
</li>
289292
<li>
290-
<strong>cpes/</strong>: secondary endpoint to lookup vulnerabilities by CPE.
293+
<strong>/v3/fixing-advisories/</strong>: endpoint to lookup for advisories that fix a given package.
294+
</li>
295+
<li>
296+
<strong>/v3/package-types/</strong>: endpoint to get package types of all the packages in the database.
291297
</li>
292298
</ul>
293299
</div>

0 commit comments

Comments
 (0)