mirror of
https://github.com/zitadel/zitadel.git
synced 2025-02-28 20:27:23 +00:00
docs: update rate limiting docs (#4186)
* docs: update rate limiting docs * reduce regexp mental overhead
This commit is contained in:
parent
872a4eae66
commit
0c6b47a081
@ -1,14 +0,0 @@
|
||||
---
|
||||
title: API Rate Limits
|
||||
---
|
||||
|
||||
<!-- //TODO Elio please update according to the current config -->
|
||||
|
||||
| Path | Description | Effective Limit |
|
||||
|-----------------------------------------------------|--------------------------|----------------------------|
|
||||
| /oauth/v2/* | Sum of all OAuth request | 500 request per 1 min |
|
||||
| /oauth/v2/token | | 120 request per 1 min |
|
||||
| /auth/v1/* | | none |
|
||||
| /caos.zitadel.auth.api.v1.AuthService/* | | none |
|
||||
| /management/v1/* | | 240 request per 1 min |
|
||||
| /caos.zitadel.management.api.v1.ManagementService/* | | 240 request per 1 min |
|
@ -1,10 +0,0 @@
|
||||
---
|
||||
title: Login Rate Limits
|
||||
---
|
||||
|
||||
<!-- //TODO Elio please update according to the current config -->
|
||||
|
||||
| Path | Description | Effective Limit |
|
||||
|---------------------|----------------------------------------|---------------------------|
|
||||
| /* | Global Login, Register and Reset Limit | none |
|
||||
| /oauth/v2/authorize | Authorize endpoint | 20 request per 10 seconds |
|
16
docs/docs/apis/ratelimits/ratelimits.md
Normal file
16
docs/docs/apis/ratelimits/ratelimits.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
title: ZITADEL Cloud Rate Limits
|
||||
---
|
||||
|
||||
| Path | Description | Throttling | One Minute Banning |
|
||||
|--------------------------|----------------------------------------|--------------------------------------|----------------------------------------|
|
||||
| /ui/login* | Global Login, Register and Reset Limit | 10 requests per second over a minute | 15 requests per sencond over 3 minutes |
|
||||
| *Various API paths* [^1] | All other gRPC- and REST APIs<br/> - Management API<br/>- Admin API<br/>- Auth API<br/>- System API | 4 requests per second over a minute | 8 requests per second over 3 minutes |
|
||||
|
||||
[^1] API paths:
|
||||
<details>
|
||||
<summary>Open to see the reqular expression</summary>
|
||||
<pre>
|
||||
/system/v[0-9]+/.*|/auth/v[0-9]+/.|/admin/v[0-9]+/.|/management/v[0-9]+/.*|zitadel\.system\.v[0-9]+\.SystemService/.*|zitadel\.admin\.v[0-9]+\.AdminService/.*|zitadel\.auth\.v[0-9]+\.AuthService/.*|zitadel\.management\.v[0-9]+\.ManagementService/.*
|
||||
</pre>
|
||||
</details>
|
@ -23,13 +23,7 @@ You should consider to implement [exponential backoff](https://en.wikipedia.org/
|
||||
|
||||
## What rate limits do apply
|
||||
|
||||
### Login, Register, Reset Limits
|
||||
|
||||
For the rate limits of the Login, Register and Reset features please visit [Login Rate Limits](/docs/apis/ratelimits/login)
|
||||
|
||||
### API Rate Limits
|
||||
|
||||
For our API rate limits please check the [API Endpoint Rate Limits](/docs/apis/ratelimits/api)
|
||||
For ZITADEL Cloud, we have a rate limiting rule for login paths (login, register and reset features) and for API paths each. Learn more about [the exact rules](/docs/apis/ratelimits).
|
||||
|
||||
## Load Testing
|
||||
|
||||
|
@ -166,7 +166,7 @@ module.exports = {
|
||||
selector: 'div#'
|
||||
},
|
||||
prism: {
|
||||
additionalLanguages: ["csharp", "dart", "groovy"],
|
||||
additionalLanguages: ["csharp", "dart", "groovy", "regex"],
|
||||
},
|
||||
},
|
||||
presets: [
|
||||
|
@ -210,9 +210,8 @@ module.exports = {
|
||||
label: "Rate Limits",
|
||||
collapsed: false,
|
||||
items: [
|
||||
"apis/ratelimits/ratelimits",
|
||||
"legal/rate-limit-policy",
|
||||
"apis/ratelimits/login",
|
||||
"apis/ratelimits/api",
|
||||
],
|
||||
},
|
||||
],
|
||||
|
Loading…
x
Reference in New Issue
Block a user