Skip to content

Commit ff5a322

Browse files
committed
Add dev keys section to rate limits page
1 parent 635d656 commit ff5a322

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/routes/docs/advanced/platform/rate-limits/+page.markdoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,18 @@ X-RateLimit-Reset: 1377013266
5050
}
5151
```
5252

53+
# Dev keys {% #dev-keys %}
54+
55+
[Dev keys](/docs/advanced/platform/dev-keys) are a type of secret used by client apps to bypass Appwrite's rate limits in development environments. They are designed to help developers test their applications without being restricted by rate limits.
56+
57+
To use dev keys, client apps add a header `X-Appwrite-Dev-Key` containing the secret to all HTTP requests sent to the Appwrite API.
58+
59+
```http
60+
X-Appwrite-Dev-Key: 5b0be23...abda7c6
61+
```
62+
63+
Dev keys should never be included in production applications as they can expose your application to abuse. They are meant for development and testing purposes only.
64+
5365
# Service abuse {% #service-abuse %}
5466

5567
To protect the quality of service from Appwrite, additional rate limits may apply to some actions. For example, rapidly creating content, polling aggressively instead of using webhooks, making API calls with a high concurrency, or repeatedly requesting data that is computationally expensive may result in abuse rate limiting.

0 commit comments

Comments
 (0)