Skip to content

feat: add docs for cloud and self hosted rate limiting #196

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

Open
rohan-chaturvedi wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: add docs for cloud and self hosted rate limiting #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c0eca1
feat: add docs for cloud and self hosted rate limiting
rohan-chaturvedi Dec 5, 2025
7c9d8d6
Update src/pages/public-api/index.mdx
rohan-chaturvedi Dec 5, 2025
99556ce
Update src/pages/public-api/index.mdx
rohan-chaturvedi Dec 5, 2025
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
29 changes: 29 additions & 0 deletions src/pages/public-api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,32 @@ curl https://api.phase.dev/v1/secrets/?app_id=8d8fde43-ceb6-4c92-a776-827433512f
## Encryption Mode

Certain API endpoints that allow manipulation of encrypted data such as Secrets require Server-side Encryption (SSE) to be enabled for the App. You can enable SSE for an App from the [App settings page](/console/apps#settings).

## Rate Limits

The Phase Cloud API enforces rate limiting to ensure fair usage and maintain optimal performance for all users. The following standard rate limits apply, based on your Organisation's plan:

| Plan | Requests per Minute |
|------|---------------------|
| Free | 120 |
| Pro | 240 |
| Enterprise | Custom |

If you exceed the allowed number of requests within a given time frame, you will receive a `429 Too Many Requests` response. The response will include information about when you can retry your request in the `retry-after` header.

```bash
HTTP/2 429
server: nginx
date: Fri, 05 Dec 2025 07:18:01 GMT
content-type: application/json
content-length: 68
retry-after: 52
allow: GET, POST, PUT, DELETE, HEAD, OPTIONS
x-frame-options: DENY
vary: Origin
x-content-type-options: nosniff
referrer-policy: same-origin
cross-origin-opener-policy: same-origin
```

Self-hosted Phase instances do not enforce rate limiting by default. However, administrators can configure rate limiting based on their requirements via the `RATE_LIMIT_DEFAULT` environment variable. Please see the self-hosting [deployment configuration documentation](/self-hosting/configuration/envars#additional-environment-variables) for more details.
5 changes: 5 additions & 0 deletions src/pages/self-hosting/configuration/envars.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -932,4 +932,9 @@ These variables are not required if using the suggested [docker-compose template
Example: `phase_license:v1:...`
Referenced by the [`backend`](https://hub.docker.com/r/phasehq/backend) and [`worker`](https://hub.docker.com/r/phasehq/backend) containers.
</Property>
<Property name="RATE_LIMIT_DEFAULT" type="string">
Rate limit for API requests.
Example: `100/minute`. Rate limits can be specified over a period of second, minute, hour or day. The period must be specified after the / separator using s, m, h or d, respectively. For increased clarity, extended units such as second, minute, hour, day or even abbreviations like sec, min, hr are allowed, as only the first character is relevant to identify the rate.
Referenced by the [`backend`](https://hub.docker.com/r/phasehq/backend) and [`worker`](https://hub.docker.com/r/phasehq/backend) containers.
</Property>
</Properties>