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.

Sign up for GitHub

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

Jump to bottom

add link to configuration docs, simplify text. #23437

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add link to configuration docs, simplify text. #23437

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 11 additions & 11 deletions apps/docs/content/guides/platform/going-into-prod.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,17 @@

- The table below shows the rate limit quotas on the following authentication endpoints. You can configure the auth rate limits for your project [here](/dashboard/project/_/auth/rate-limits).

| Endpoint | Path | Limited By | Rate Limit |
| ------------------------------------------------ | -------------------------------------------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| All endpoints that send emails | `/auth/v1/signup` `/auth/v1/recover` `/auth/v1/user`[^1] | Sum of combined requests | Defaults to 30 emails per hour. As of 14th July 2023, this has been updated to 4 emails per hour. As of 21 Oct 2023, this has been updated to 3 emails per hour. You can only change this with your own custom SMTP setup. |
| All endpoints that send One-Time-Passwords (OTP) | `/auth/v1/otp` | Sum of combined requests | Defaults to 30 OTPs per hour. Is customizable. |
| Send OTPs or magiclinks | `/auth/v1/otp` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. |
| Signup confirmation request | `/auth/v1/signup` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. |
| Password Reset Request | `/auth/v1/recover` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. |
| Verification requests | `/auth/v1/verify` | IP Address | 360 requests per hour (with bursts up to 30 requests) |
| Token refresh requests | `/auth/v1/token` | IP Address | 1800 requests per hour (with bursts up to 30 requests) |
| Create or Verify an MFA challenge | `/auth/v1/factors/:id/challenge` `/auth/v1/factors/:id/verify` | IP Address | 15 requests per minute (with bursts up to 30 requests) |
| Anonymous sign-ins | `/auth/v1/signup`[^2] | IP Address | 30 requests per hour (with bursts up to 30 requests) |
| Endpoint | Path | Limited By | Rate Limit |
| ------------------------------------------------ | -------------------------------------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| All endpoints that send emails | `/auth/v1/signup` `/auth/v1/recover` `/auth/v1/user`[^1] | Sum of combined requests | As of 21 Oct 2023, this has been updated to 3 emails per hour. You can only change this with your own [custom SMTP setup](/docs/guides/auth/auth-smtp). |

Check warning on line 68 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Custom.Acronyms] The first instance of 'SMTP' should be spelled out, followed by the acronym in brackets. For example: 'Data Definition Language (DDL)'

Raw Output:
{"message": "[Custom.Acronyms] The first instance of 'SMTP' should be spelled out, followed by the acronym in brackets. For example: 'Data Definition Language (DDL)'", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 68, "column": 256}}}, "severity": "INFO"}
| All endpoints that send One-Time-Passwords (OTP) | `/auth/v1/otp` | Sum of combined requests | Defaults to 30 OTPs per hour. Is customizable. |

Check failure on line 69 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'OTPs'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'OTPs'?", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 69, "column": 161}}}, "severity": "ERROR"}
| Send OTPs or magiclinks | `/auth/v1/otp` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. |

Check failure on line 70 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'OTPs'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'OTPs'?", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 70, "column": 8}}}, "severity": "ERROR"}

Check failure on line 70 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'magiclinks'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'magiclinks'?", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 70, "column": 16}}}, "severity": "ERROR"}
| Signup confirmation request | `/auth/v1/signup` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. |
| Password Reset Request | `/auth/v1/recover` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. |
| Verification requests | `/auth/v1/verify` | IP Address | 360 requests per hour (with bursts up to 30 requests) |

Check warning on line 73 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Custom.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Custom.Parens] Use parentheses judiciously.", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 73, "column": 168}}}, "severity": "INFO"}
| Token refresh requests | `/auth/v1/token` | IP Address | 1800 requests per hour (with bursts up to 30 requests) |

Check warning on line 74 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Custom.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Custom.Parens] Use parentheses judiciously.", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 74, "column": 169}}}, "severity": "INFO"}
| Create or Verify an MFA challenge | `/auth/v1/factors/:id/challenge` `/auth/v1/factors/:id/verify` | IP Address | 15 requests per minute (with bursts up to 30 requests) |

Check warning on line 75 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Custom.Acronyms] The first instance of 'MFA' should be spelled out, followed by the acronym in brackets. For example: 'Data Definition Language (DDL)'

Raw Output:
{"message": "[Custom.Acronyms] The first instance of 'MFA' should be spelled out, followed by the acronym in brackets. For example: 'Data Definition Language (DDL)'", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 75, "column": 23}}}, "severity": "INFO"}

Check warning on line 75 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Custom.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Custom.Parens] Use parentheses judiciously.", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 75, "column": 169}}}, "severity": "INFO"}
| Anonymous sign-ins | `/auth/v1/signup`[^2] | IP Address | 30 requests per hour (with bursts up to 30 requests) |

Check warning on line 76 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Custom.WordList] Use 'signin(s) (noun) or sign in (verb)' instead of 'sign-ins'.

Raw Output:
{"message": "[Custom.WordList] Use 'signin(s) (noun) or sign in (verb)' instead of 'sign-ins'.", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 76, "column": 13}}}, "severity": "WARNING"}

Check warning on line 76 in apps/docs/content/guides/platform/going-into-prod.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Custom.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Custom.Parens] Use parentheses judiciously.", "location": {"path": "apps/docs/content/guides/platform/going-into-prod.mdx", "range": {"start": {"line": 76, "column": 167}}}, "severity": "INFO"}

### Realtime quotas

Expand Down