extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-06-19 17:27:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add limits doc

Browse Source
This commit is contained in:
Mike Guthrie 2025-04-11 11:50:45 -04:00
parent 28bf9a2bde
commit 5a052ee86b
No known key found for this signature in database
GPG Key ID: 1B882E45188DB83B
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/myzrok/limits.md Normal file
View File

@ -0,0 +1,32 @@
---
title: Limits
---
NetFoundry's public zrok instance implements various limits based on pricing tier,
as well as rate limits in order to protect the service for all users.
### Limits on Shares, Environments, or Bandwidth
The number of shares, enviroments, or allowed bandwidth is based on the limits outlined within your myzrok subscription.
These limits are defined on the [zrok pricing](https://zrok.io/pricing/) page.
Bandwidth limitations are based on a rolling 24 hour window. Note that if you exceed the daily bandwidth of your plan,
any running shares will be disabled, and the zrok API will prevent any new shares from being created until the bandwidth
falls back below the 24 hour limit.
### Rate Limitations For Public Shares
Public shares are subject to API rate limiting, both by IP address, as well as the individual share token.
These limits exist to protect the zrok service so that one user does not negatively impact the experience for others.
The rate limits for public shares are defined below:
#### Per IP Address
2000 requests per 300 seconds (average of 6.66 requests per second)
The rate limiter will allow a burst of requests in a shorter timespan up to 2000 requests, but once the rate limit has been exceeded,
new requests will be blocked until the request rate falls below the limit of the 300 second window.
#### Per Share
7500 requests per 300 seconds from *any number of IP addresses* (average of 25 requests per second)