Permalink
Browse files

Merge pull request #181 from rubygems/rate-limits

add section on rate limits
  • Loading branch information...
2 parents 05c5d02 + 2c041f3 commit 8fb70160cc89b53e6aa977e392cbab9d9b1576ca @dwradcliffe dwradcliffe committed on GitHub Mar 30, 2017
Showing with 14 additions and 0 deletions.
  1. +14 −0 rubygems-org-api.md
View
@@ -14,6 +14,7 @@ next: /run-your-own-gem-server
> add owners, and more.
* [API Authorization](#api-authorization): How to authenticate with RubyGems.org
+* [Rate Limits](#rate-limits)
* [Gem Methods](#gem-methods): Query or create gems to be hosted
* [Gem Version Methods](#gem-version-methods): Query for information about
versions of a particular gem
@@ -47,6 +48,19 @@ examples in the README. You can install the library with the command:
gem install gems
+Rate Limits
+-----------
+
+To protect the RubyGems.org service from abuse, both intentionally and unintentionally, we have rate limits in place for some of our endpoints. Some endpoints may be cached by our CDN at times and therefore _may_ allow higher request rates. The following is a general guideline for the rate limit rules.
+
+* API and website: 10 requests per second
+* Dependency API: 15 requests per second
+* Website sign up, sign in, api key, and forgot password: 100 requests per 10 minutes
+
+Users who hit a rate limit will see HTTP 429 responses, for the remainder of the limit window. Usually this is just a few minutes.
+
+The RubyGems.org team may occasionally blackhole user IP addresses for extreme cases to protect the platform. If you think this has happened to you, please [submit a help ticket](http://help.rubygems.org/discussion/new) and we'll be happy to look at it.
+
Gem Methods
-----------

0 comments on commit 8fb7016

Please sign in to comment.