diff --git a/docs/docs/apis/ratelimits/api.md b/docs/docs/apis/ratelimits/api.md deleted file mode 100644 index b5fef8da44..0000000000 --- a/docs/docs/apis/ratelimits/api.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: API Rate Limits ---- - - - -| 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 | diff --git a/docs/docs/apis/ratelimits/login.md b/docs/docs/apis/ratelimits/login.md deleted file mode 100644 index fe0f4b6261..0000000000 --- a/docs/docs/apis/ratelimits/login.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Login Rate Limits ---- - - - -| Path | Description | Effective Limit | -|---------------------|----------------------------------------|---------------------------| -| /* | Global Login, Register and Reset Limit | none | -| /oauth/v2/authorize | Authorize endpoint | 20 request per 10 seconds | diff --git a/docs/docs/apis/ratelimits/ratelimits.md b/docs/docs/apis/ratelimits/ratelimits.md new file mode 100644 index 0000000000..b4af8eb0ef --- /dev/null +++ b/docs/docs/apis/ratelimits/ratelimits.md @@ -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
- Management API
- Admin API
- Auth API
- System API | 4 requests per second over a minute | 8 requests per second over 3 minutes | + +[^1] API paths: +
+ Open to see the reqular expression +
+/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/.*
+    
+
diff --git a/docs/docs/legal/rate-limit-policy.md b/docs/docs/legal/rate-limit-policy.md index 094af0f306..4f4e2b4140 100644 --- a/docs/docs/legal/rate-limit-policy.md +++ b/docs/docs/legal/rate-limit-policy.md @@ -23,15 +23,9 @@ 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 -If you would like to conduct load testing of ZITADEL Cloud or a managed instance, you MUST request to do so with a minimum of 2 weeks notice before the test by contacting us at support@zitadel.com. +If you would like to conduct load testing of ZITADEL Cloud or a managed instance, you MUST request to do so with a minimum of 2 weeks notice before the test by contacting us at support@zitadel.com. You MUST NOT conduct load testing without prior approval by us. Without prior approval and setup there is a high risk of being flagged by our DDoS solution as malicious traffic. This can have a severe impact on your service quality or result in termination of your agreement. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 77322f0155..c09e8add03 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -155,7 +155,7 @@ module.exports = { } ], }, - + ], copyright: `Copyright © ${new Date().getFullYear()} ZITADEL Docs - Built with Docusaurus.`, }, @@ -166,7 +166,7 @@ module.exports = { selector: 'div#' }, prism: { - additionalLanguages: ["csharp", "dart", "groovy"], + additionalLanguages: ["csharp", "dart", "groovy", "regex"], }, }, presets: [ diff --git a/docs/sidebars.js b/docs/sidebars.js index 1a35b3b0fe..c6d99111cc 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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", ], }, ],