Client Reference
Access Rules
Access Rules endpoint reference.
List
List, search, sort, and filter a zone's IP Access rules.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
params | array | No | [] | Query Parameters. |
php
$response = $client->accessRules()->list('ZONE_ID', []);
Create
Create a new IP Access rule for a zone.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
values | array | Yes | Values to set on the IP Access rule, e.g. `mode`, `configuration` (`target`, `value`), `notes`. |
php
$response = $client->accessRules()->create('ZONE_ID', []);
Edit
Apply changes to an existing IP Access rule for a zone, overwriting only the supplied properties.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
ruleId | string | Yes | IP Access Rule Identifier. | |
values | array | Yes | Values to set on the IP Access rule, e.g. `mode`, `notes`. |
php
$response = $client->accessRules()->edit('ZONE_ID', 'RULE_ID', []);
Delete
Delete an IP Access rule for a zone.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
ruleId | string | Yes | IP Access Rule Identifier. |
php
$response = $client->accessRules()->delete('ZONE_ID', 'RULE_ID');

