Client Reference
Filters
Filters endpoint reference.
List
List, search, sort, and filter a zone's filters.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
params | array | No | [] | Query Parameters. |
php
$response = $client->filters()->list('ZONE_ID', []);
Get
Get a single filter.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
filterId | string | Yes | Filter Identifier. |
php
$response = $client->filters()->get('ZONE_ID', 'FILTER_ID');
Create
Create one or more filters.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
filters | array | Yes | Array of filter definitions, e.g. `[['expression' => 'ip.src eq 127.0.0.1']]`. |
php
$response = $client->filters()->create('ZONE_ID', []);
Update
Update an existing filter.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
filterId | string | Yes | Filter Identifier. | |
values | array | Yes | Values to set on the filter. |
php
$response = $client->filters()->update('ZONE_ID', 'FILTER_ID', []);
Delete
Delete a filter.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
filterId | string | Yes | Filter Identifier. |
php
$response = $client->filters()->delete('ZONE_ID', 'FILTER_ID');

