List Page Rules

Fetches Page Rules in a zone.

application/json

Body

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

result

required

Any of

allOf {2}

array[object (page-rule) {7}]

allOf {2}

One of

array[object (page-rule) {7}]

object

actions

array [oneOf]

schemas-actions

required

The set of actions to perform if the targets of this rule match the request. Actions can redirect to another URL or override settings, but not both.

Example:

[{"id":"browser_check","value":"on"}]

created_on

string <date-time>

created_on

read-onlyrequired

The timestamp of when the Page Rule was created.

Example:

2014-01-01T05:20:00.12345Z

string

common_components-schemas-identifier

read-onlyrequired

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

modified_on

string <date-time>

page-rule_components-schemas-modified_on

read-onlyrequired

The timestamp of when the Page Rule was last modified.

Example:

2014-01-01T05:20:00.12345Z

priority

integer

page-rule_components-schemas-priority

required

The priority of the rule, used to define which Page Rule is processed over another. A higher number indicates a higher priority. For example, if you have a catch-all Page Rule (rule A: /images/*) but want a more specific Page Rule to take precedence (rule B: /images/special/*), specify a higher priority for rule B so it overrides rule A.

Default:

status

enum<string>

page-rule_components-schemas-status

required

The status of the Page Rule.

Allowed values:

activedisabled

Default:

disabled

Example:

active

targets

array[null (target) {1}]

targets

required

The rule targets to evaluate on each request.

Example:

[{"constraint":{"operator":"matches","value":"*example.com/images/*"},"target":"url"}]

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "actions": [
                {
                    "id": "browser_check",
                    "value": "on"
                }
            ],
            "created_on": "2014-01-01T05:20:00.12345Z",
            "id": "023e105f4ecef8ad9ca31a8372d0c353",
            "modified_on": "2014-01-01T05:20:00.12345Z",
            "priority": 1,
            "status": "active",
            "targets": [
                {
                    "constraint": {
                        "operator": "matches",
                        "value": "*example.com/images/*"
                    },
                    "target": "url"
                }
            ]
        }
    ],
    "success": true
}

Request

Request samples

Responses