Client Reference
Firewall Rules
Firewall Rules endpoint reference.
List
List, search, sort, and filter a zone's firewall rules.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
params | array | No | [] | Query Parameters. |
php
$response = $client->firewallRules()->list('ZONE_ID', []);
Get
Get a single firewall rule.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
ruleId | string | Yes | Firewall Rule Identifier. |
php
$response = $client->firewallRules()->get('ZONE_ID', 'RULE_ID');
Create
Create one or more firewall rules.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
rules | array | Yes | Array of firewall rule definitions, each referencing a filter by id (`filter: {id}`) or by inline expression (`filter: {expression}`), e.g. `[['action' => 'block', 'filter' => ['expression' => 'ip.src eq 127.0.0.1']]]`. |
php
$response = $client->firewallRules()->create('ZONE_ID', []);
Update
Update an existing firewall rule.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
ruleId | string | Yes | Firewall Rule Identifier. | |
values | array | Yes | Values to set on the firewall rule. |
php
$response = $client->firewallRules()->update('ZONE_ID', 'RULE_ID', []);
Update Priority
Update the priority of an existing firewall rule.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
ruleId | string | Yes | Firewall Rule Identifier. | |
priority | int | Yes | The priority of the rule, used to define the processing order. A lower number indicates a higher priority. |
php
$response = $client->firewallRules()->updatePriority('ZONE_ID', 'RULE_ID', 1);
Delete
Delete a firewall rule.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
ruleId | string | Yes | Firewall Rule Identifier. |
php
$response = $client->firewallRules()->delete('ZONE_ID', 'RULE_ID');