Skip to content

Commit

Permalink
docs: DOC-1646: Update API Rate Limit for v1/cloudconfig Resources (#…
Browse files Browse the repository at this point in the history 
…5609)

* Updating API rate limit for v1/cloudconfigs resources; adding to 4.6 release notes as improvement

* Changing link from relative to direct URL

* ci: auto-formatting prettier issues

---------

Co-authored-by: achuribooks <[email protected]>
  • Loading branch information
@achuribooks
achuribooks and achuribooks authored Jan 31, 2025
1 parent 37aa5f6 commit 163ab12
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/api-content/api-docs/1-introduction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,9 @@ curl --location 'https://api.spectrocloud.com/v1/packs?continue=eyJvZmZzZXQiOjUw

The API rate limits are as follows:

- There is a limit of ten API requests per second for each source IP address. The API supports additional bursts through
the usage of a burst queue. The default burst queue size is set to five. You could make 50 (10 \* 5) requests in
seconds before the API returns a `429 - TooManyRequests` error. Refer to the
- Most Palette APIs have a limit of ten API requests per second for each source IP address. The API supports additional
bursts through the usage of a burst queue. The default burst queue size is set to five. You could make 50 (10 \* 5)
requests in seconds before the API returns a `429 - TooManyRequests` error. Refer to the
[Endpoint Prefix Rate](#endpoint-prefix-rate) for additional information.

- API request limits are categorized by the parent resources, such as `/v1/cloudconfig/:uid` and `/v1/roles`. You can
Expand Down Expand Up @@ -225,8 +225,8 @@ The API rate limits are as follows:
| /v1/services | 10 | 5 | 50 |
| /v1/overlords | 10 | 5 | 50 |
| /v1/cluster | 10 | 5 | 50 |
| /v1/cloudconfigs | 10 | 5 | 50 |
| /v1/cloudconfigs/\{cloudType}/\{uid}/machinePools | 10 | 5 | 50 |
| /v1/cloudconfigs | 50 | 5 | 250 |
| /v1/cloudconfigs/\{cloudType}/\{uid}/machinePools | 50 | 5 | 250 |
| /v1/edgehosts | 10 | 5 | 50 |
| /v1/metrics | 10 | 5 | 50 |
| /v1/system | 10 | 5 | 50 |
Expand All @@ -235,8 +235,8 @@ The API rate limits are as follows:
| /v1/clouds | 10 | 5 | 50 |
| /v1/events/components | 10 | 5 | 50 |
| /v1/dashboard | 10 | 5 | 50 |
| /v1/cloudconfigs/\{cloudType}/:uid/machinePools/\{machinePoolName}/machines | 10 | 5 | 50 |
| /v1/cloudconfigs/\{cloudType}/:uid/machinePools/\{machinePoolName}/machines/:machineUid | 10 | 5 | 50 |
| /v1/cloudconfigs/\{cloudType}/:uid/machinePools/\{machinePoolName}/machines | 50 | 5 | 250 |
| /v1/cloudconfigs/\{cloudType}/:uid/machinePools/\{machinePoolName}/machines/:machineUid | 50 | 5 | 250 |
| /v1/auth/authenticate | 10 | 5 | 50 |
| /v1/auth/services/login | 10 | 5 | 50 |
| /v1/auth/services/edge/login | 10 | 5 | 50 |
Expand Down
4 changes: 4 additions & 0 deletions docs/docs-content/release-notes/release-notes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ soluta voluptatibus quibusdam aut autem. Repellendus magni nostrum ex et autem d

#### Improvements

- The [rate limit](https://docs.spectrocloud.com/api/introduction/#rate-limits) for Palette API endpoints with a prefix
of `/v1/cloudconfigs` has been increased to 50 requests per second per IP address, and the maximum burst has been
increased to 250 requests per second per IP address.

#### Deprecations and Removals

### Edge
Expand Down

0 comments on commit 163ab12

Please sign in to comment.