diff options
Diffstat (limited to 'docs/api/swagger.md')
| -rw-r--r-- | docs/api/swagger.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/api/swagger.md b/docs/api/swagger.md index 50191f18d..5368e8720 100644 --- a/docs/api/swagger.md +++ b/docs/api/swagger.md @@ -1,5 +1,16 @@ # API Documentation +## Rate limit + +To prevent abuse of the API an IP-based HTTP rate limit is in place, a maximum of 300 requests in a 5 minutes time window are allowed, every response will include the current status of the rate limit with the following headers: + +- `x-ratelimit-limit` maximum number of requests allowed per time period (fixed) +- `x-ratelimit-remaining` number of remaining requests that can still be performed +- `x-ratelimit-reset` unix timestamp when the rate limit will reset + +In case the rate limit is exceeded an HTTP 429 error is returned to the caller. + + GoToSocial uses [go-swagger](https://github.com/go-swagger/go-swagger) to generate a V2 [OpenAPI specification](https://swagger.io/specification/v2/) document from code annotations. The resulting API documentation is rendered below, for quick reference. |