Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: document rate-limits #1601

Merged
merged 9 commits into from
Dec 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/guides/rate-limits.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: rate-limits
title: Project Rate Limits
sidebar_label: Rate Limits
---

Ory Network currently enforces three rate limit policies based on the path of your request.

1. `/sessions/whoami`: a dedicated rate limit policy for session checks.
2. `/identities`: a dedicated rate limit policy for identity inserts and updates.
tricky42 marked this conversation as resolved.
Show resolved Hide resolved
3. `*`: rate limit policy for all remaining calls.

Each of these policies incorporates two types of rate limits:

1. The `burst` limit, which regulates the maximum number of requests per second, allowing brief spikes in request volume.
2. The `sustained` limit, controlling the number of requests over a one-minute period.

The table below outlines the rate limit thresholds for each subscription plan tier, as per these three policies:

| Subscription Plan | Path / Bucket | Rate Limits (burst/sustained) |
| ----------------- | ------------------------------------------ | ---------------------------------------------------------------- |
| Develop | /sessions/whoami:<br/>/identities:<br/>\*: | 15 rps / 450 rpm <br/>1 rps / 10 rpm <br/>15 rps / 450 rpm |
| Essentials | /sessions/whoami:<br/>/identities:<br/>\*: | 80 rps / 1800 rpm<br/>10 rps / 300 rpm<br/>40 rps / 900 rpm<br/> |
| Scale | /sessions/whoami:<br/>/identities:<br/>\*: | 800 rps / 18000 rpm<br/>20 rps / 600 rpm<br/>400 rps / 9000 rpm |
7 changes: 6 additions & 1 deletion src/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,12 @@ module.exports = {
{
type: "category",
label: "From dev to prod",
items: ["guides/custom-domains", "guides/cors", "guides/gitops"],
items: [
"guides/custom-domains",
"guides/cors",
"guides/gitops",
"guides/rate-limits",
],
},
{
type: "category",
Expand Down
Loading