Client Reference
Rate Limits
Rate Limits endpoint reference.
List
List, search, sort, and filter a zone's rate limits.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
params | array | No | [] | Query Parameters. |
php
$response = $client->rateLimits()->list('ZONE_ID', []);
Get
Get a single rate limit.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
rateLimitId | string | Yes | Rate Limit Identifier. |
php
$response = $client->rateLimits()->get('ZONE_ID', 'RATE_LIMIT_ID');
Create
Create a new rate limit for a zone.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
values | array | Yes | Values to set on the rate limit, e.g. `threshold`, `period`, `match`, `action`. |
php
$response = $client->rateLimits()->create('ZONE_ID', []);
Update
Update an existing rate limit for a zone.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
rateLimitId | string | Yes | Rate Limit Identifier. | |
values | array | Yes | Values to set on the rate limit, e.g. `threshold`, `period`, `match`, `action`. |
php
$response = $client->rateLimits()->update('ZONE_ID', 'RATE_LIMIT_ID', []);
Delete
Delete a rate limit for a zone.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
rateLimitId | string | Yes | Rate Limit Identifier. |
php
$response = $client->rateLimits()->delete('ZONE_ID', 'RATE_LIMIT_ID');

