Skip to content

Commit a371363

Browse files
committed
Update headers; add rate limit info
1 parent e23f8fa commit a371363

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

openapi.yaml

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -341,53 +341,54 @@ info:
341341

342342
## Rate Limiting
343343

344-
With the Linode API, you can make up to 1,600 general API requests every two minutes per user as determined by IP address or by OAuth token. Additionally, all endpoints have a global limit of 800 requests per minute per user along with specific endpoint limits defined below.
344+
Rate limits on API requests help maintain the health and stability of the Linode API. Every endpoint of the Linode API applies a rate limit on a per user basis as determined by IP address or by OAuth token.
345+
346+
Each rate limit consists of a total number of requests and a time window. For example, if an endpoint has a rate limit of 800 requests per minute, then up to 800 requests over a one minute window are permitted. Subsequent requests to an endpoint after hitting a rate limit return a 429 error. You can successfully remake requests to that endpoint after the rate limit window resets.
347+
348+
### Linode APIv4 Rate Limits
349+
350+
With the Linode API, you can make up to 1,600 general API requests every two minutes. Additionally, all endpoints have a global limit of 800 requests per minute unless otherwise specified below.
345351

346352
**Note:** There may be rate limiting applied at other levels outside of the API, for example, at the load balancer.
347353

348-
Creating Linodes has a dedicated limit of 10 requests per 30 seconds per user.
349-
That endpoint is:
354+
Creating Linodes has a dedicated limit of 10 requests per 30 seconds. That endpoint is:
350355

351356
* [Linode Create](/docs/api/linode-instances/#linode-create)
352357

353-
`/stats` endpoints have their own dedicated limits of 100 requests per minute per user.
354-
These endpoints are:
358+
`/stats` endpoints have their own dedicated limits of 100 requests per minute. These endpoints are:
355359

356360
* [View Linode Statistics](/docs/api/linode-instances/#linode-statistics-view)
357361
* [View Linode Statistics (year/month)](/docs/api/linode-instances/#statistics-yearmonth-view)
358362
* [View NodeBalancer Statistics](/docs/api/nodebalancers/#nodebalancer-statistics-view)
359363
* [List Managed Stats](/docs/api/managed/#managed-stats-list)
360364

361-
Object Storage endpoints have a dedicated limit of 750 requests per second per user.
362-
The Object Storage endpoints are:
365+
Object Storage endpoints have a dedicated limit of 750 requests per second. The Object Storage endpoints are:
363366

364367
* [Object Storage Endpoints](/docs/api/object-storage/)
365368

366-
Opening Support Tickets has a dedicated limit of 2 requests per minute per user.
367-
That endpoint is:
369+
Opening Support Tickets has a dedicated limit of 2 requests per minute. That endpoint is:
368370

369371
* [Open Support Ticket](/docs/api/support/#support-ticket-open)
370372

371-
Accepting Service Transfers has a dedicated limit of 2 requests per minute per user.
372-
That endpoint is:
373+
Accepting Service Transfers has a dedicated limit of 2 requests per minute. That endpoint is:
373374

374375
* [Service Transfer Accept](/docs/api/account/#service-transfer-accept)
375376

376-
All GET requests to endpoints that return a `data` collection have a dedicated limit of 100 requests per minute and 10 requests per second per user.
377+
All GET requests to endpoints that return a data collection have dedicated limits of 100 requests per minute and 10 requests per second.
377378

378-
## Rate Limit Response Headers
379+
### Rate Limit HTTP Response Headers
379380

380-
The Linode API includes the following HTTP response headers related to rate limiting:
381+
The Linode API includes the following HTTP response headers that are designed to help you avoid hitting rate limits that might disrupt your applications:
381382

382383
* **X-RateLimit-Limit**: The maximum number of permitted requests during the rate limit window for this endpoint.
383384
* **X-RateLimit-Remaining**: The remaining number of permitted requests in the current rate limit window.
384385
* **X-RateLimit-Reset**: The time when the current rate limit window rests in UTC epoch seconds.
385386
* **Retry-After**: The remaining time in seconds until the current rate limit window resets.
386387

387-
To view HTTP response headers when making requests with `curl`, use the `-i` or `--include` option. For example:
388+
There are many ways to access header information for your requests, depending on how you are accessing the Linode API. For example, to view HTTP response headers when making requests with `curl`, use the `-i` or `--include` option as follows:
388389

389390
```Shell
390-
curl -i "https://api.linode.com/v4/regions"
391+
curl -i https://api.linode.com/v4/regions
391392
```
392393

393394
## CLI (Command Line Interface)

0 commit comments

Comments
 (0)