List User Agent Blocking rules

Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters.

application/json

Body

result

required

Any of

allOf {2}

array[object (ua-rules) {5}]

allOf {2}

One of

array[object (ua-rules) {5}]

object

configuration

object

components-schemas-configuration

optional

The configuration object for the current rule.

description

string

ua-rules_components-schemas-description

optional

An informative summary of the rule.

<= 1024 characters

Example:

Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack

string

ua-rules_components-schemas-id

read-onlyoptional

The unique identifier of the User Agent Blocking rule.

<= 32 characters

Example:

372e67954025e0ba6aaa6d586b9e0b59

mode

ua-rules_components-schemas-mode

optional

The action to apply to a matched request.

Allowed values:

blockchallengejs_challengemanaged_challenge

Example:

js_challenge

paused

boolean

components-schemas-paused

optional

When true, indicates that the rule is currently paused.

Example:

false

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": [
        {
            "configuration": {
                "target": "ua",
                "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
            },
            "description": "Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack",
            "id": "372e67954025e0ba6aaa6d586b9e0b59",
            "mode": "js_challenge",
            "paused": false
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List User Agent Blocking rules

Request

Request samples

Responses