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

rest API limits documentation is updated #526

Merged
merged 10 commits into from
Oct 12, 2023
Merged

rest API limits documentation is updated #526

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fce3785
rest API limits documentation is updated
isumygin-sc Oct 12, 2023
deaac58
rest API limits documentation is updated
isumygin-sc Oct 12, 2023
1971226
Update content/en/user-manual/api/asset-update.md
isumygin-sc Oct 12, 2023
8528565
Update content/en/user-manual/api/asset-create.md
isumygin-sc Oct 12, 2023
c2aa810
Update content/en/user-manual/api/index.md
isumygin-sc Oct 12, 2023
7a92611
table for limits
isumygin-sc Oct 12, 2023
b7f27ca
table for limits
isumygin-sc Oct 12, 2023
cb91da9
update ru documentation
isumygin-sc Oct 12, 2023
5925590
update ru documentation
isumygin-sc Oct 12, 2023
3f266b2
update ru documentation
isumygin-sc Oct 12, 2023
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
2 changes: 1 addition & 1 deletion content/en/user-manual/api/asset-create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,6 @@ Status: 201

## Rate Limiting

This route uses a [strict][1] rate limit.
This route uses a [assets][1] rate limit.
isumygin-sc marked this conversation as resolved.
Show resolved Hide resolved

[1]: /user-manual/api#rate-limiting
2 changes: 1 addition & 1 deletion content/en/user-manual/api/asset-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,6 @@ Status: 200

## Rate Limiting

This route uses a [strict][1] rate limit.
This route uses a [assets][1] rate limit.
isumygin-sc marked this conversation as resolved.
Show resolved Hide resolved

[1]: /user-manual/api#rate-limiting
8 changes: 5 additions & 3 deletions content/en/user-manual/api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,12 @@ Also the status code of the response will be the appropriate HTTP error code.

## Rate Limiting

Calls to the REST API have a rate limit. There are different rate limits depending on the request:
Calls to the REST API have a rate limit. Check your actual limits by querying [this endpoint](https://playcanvas.com/api/ratelimits)
isumygin-sc marked this conversation as resolved.
Show resolved Hide resolved
There are different rate limits depending on the request:

* **normal:** The normal rate limit allows 120 requests per minute.
* **strict:** The strict rate limit allows 5 requests per minute.
* **normal:** The normal rate limit allows 120-240 requests per minute.
* **strict:** The strict rate limit allows 5-10 requests per minute.
* **assets:** The assets rate limit allows 60-120 requests per minute.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to provide an explanation here for why there's a range instead of a specific number?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to provide an explanation here for why there's a range instead of a specific number?

updated as a table


The response will contain the following headers to help you regulate how often you call the API:

Expand Down
Loading