Skip to content

Commit

Permalink
Add warnings about special quota limitation scenarios (#544)
Browse files Browse the repository at this point in the history
  • Loading branch information
ggalmazor authored Nov 30, 2023
1 parent 3a3e752 commit f9e9f76
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
7 changes: 5 additions & 2 deletions content/v2.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ List all domains in the account `1010` sorting them by expiration date (asc) and

There is a limit to the number of requests that you can perform per hour.

- For **authenticated requests** you can make **up to 2400 requests per hour**.
- For **authenticated requests**, you can make **up to 2400 requests per hour**.
- For **unauthenticated requests**, you can make **up to 30 requests per hour**.

You can see your current rate limit status by checking the HTTP headers of any API request:
Expand All @@ -416,7 +416,7 @@ The headers have all the information you need to know about your current rate li
| `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. |
| `X-RateLimit-Reset` | The time at which the current rate limit window in [Unix time](https://en.wikipedia.org/wiki/Unix_time) format. |

Once you go over the rate limit you will receive an error response:
Once you go over the rate limit, you will receive an error response:

~~~
$ curl -H "Authorization: Bearer ACCESS-TOKEN" -I "https://api.dnsimple.com/v2/whoami"
Expand All @@ -431,6 +431,9 @@ Content-Length: 28
{"message":"quota exceeded"}
~~~

<warning>
Individual API endpoints may have additional mechanisms in place to prevent abuse.
</warning>

## More Examples

Expand Down
4 changes: 4 additions & 0 deletions content/v2/registrar.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ excerpt: This page documents the DNSimple registry/registrar API v2.

## Check domain {#checkDomain}

<warning>
This API endpoint has stricter limits in place to avoid a high volume of requests. This endpoint should be used only to check a domain's state before issuing a domain registration or a domain transfer. For other use cases, we recommend using other services like [Domainr](https://domainr.com/).
</warning>

Checks a domain name for availability.

~~~
Expand Down

0 comments on commit f9e9f76

Please sign in to comment.