Create filters

Creates one or more filters.

application/json

Body

result

required

Any of

allOf {2}

array[object (filter) {5}]

allOf {2}

One of

array[object (filter) {5}]

object

description

string

filters_components-schemas-description

optional

An informative summary of the filter.

<= 500 characters

Example:

Restrict access from these browsers on this address range.

expression

string

expression

optional

The filter expression. For more information, refer to Expressions.

Example:

(http.request.uri.path ~ ".*wp-login.php" or http.request.uri.path ~ ".*xmlrpc.php") and ip.addr ne 172.16.22.155

string

filters_components-schemas-id

read-onlyoptional

The unique identifier of the filter.

>= 32 characters<= 32 characters

Example:

372e67954025e0ba6aaa6d586b9e0b61

paused

boolean

filters_components-schemas-paused

optional

When true, indicates that the filter is currently paused.

Example:

false

ref

string

schemas-ref

optional

A short reference tag. Allows you to select related filters.

<= 50 characters

Example:

FIL-100

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "description": "Restrict access from these browsers on this address range.",
            "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
            "id": "372e67954025e0ba6aaa6d586b9e0b61",
            "paused": false,
            "ref": "FIL-100"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses