Rate Limit Header Guarantees

[mealingr]

Select Topic Area

Question

Body

Hi All,

I'd be very grateful if anyone could help answer these questions:

1. If we receive a (primary) rate limit exceeded response, is the response guaranteed to have the following headers:

x-ratelimit-limit
x-ratelimit-remaining
x-ratelimit-used
x-ratelimit-reset
x-ratelimit-resource

?
(https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28#dealing-with-rate-limits implies x-ratelimit-reset at least is always present)

2. If we receive a secondary rate limit exceeded response, is the response guaranteed to have the above headers and/or a
   retry-after header? (https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28#dealing-with-secondary-rate-limits implies retry-after may not always be present)

Thanks

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬