Skip to content

Commit 7087d25

Browse files
authored
Add rate limit note; suggest caching/etags (#5614)
* Add rate limit note; suggest caching/etags * Update content/developers/overview/secret-scanning.md
1 parent b1da73c commit 7087d25

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

content/developers/overview/secret-scanning.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,12 @@ We strongly recommend you implement signature validation in your secret alert se
8888

8989
You can retrieve the {% data variables.product.prodname_dotcom %} secret scanning public key from https://api.github.com/meta/public_keys/secret_scanning and validate the message using the `ECDSA-NIST-P256V1-SHA256` algorithm.
9090

91+
{% note %}
92+
93+
**Note**: When you send a request to the public key endpoint above, you may hit rate limits. To avoid hitting rate limits, you can use a personal access token as suggested below, or use a conditional request. For more information, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api#conditional-requests)."
94+
95+
{% endnote %}
96+
9197
Assuming you receive the following message, the code snippets below demonstrate how you could perform signature validation.
9298
The code also assumes you've set an environment variable called `GITHUB_PRODUCTION_TOKEN` with a generated PAT (https://github.com/settings/tokens). The token does not need any permissions set.
9399

@@ -358,4 +364,3 @@ A few important points:
358364
**Note:** Our request timeout is set to be higher (that is, 30 seconds) for partners who provide data about false positives. If you require a timeout higher than 30 seconds, email us at <a href="mailto:secret-scanning@github.com">secret-scanning@github.com</a>.
359365
360366
{% endnote %}
361-

0 commit comments

Comments
 (0)