List rules

get https://api.wp.pro/v1/site/{site_id}/rules

Response

Response body

object

success

boolean

required

Success indicator

message

string

Human readable (error) message

result

object

Query result

count

number

rules

array of objects

rules

object

hash

string

required

filter

string

required

Defaults to request_filter

At what point in the process should the rule be applied?

request_filter response_filter upstream_request_filter upstream_response_filter

scope

string

required

CDN WAF

priority

number

required

Defaults to 100

expression

string

required

action

string

allow block

instructions

array of objects

List of optional instructions

instructions

object

hash

string

instruction

string

required

cache bypass redirect challenge rate_limit authentication cache_control minify_html minify_css minify_js brotli gzip

value

string

required

enabled

boolean

required

Determines whether the new rule should be activated or saved as deactivated

skip

boolean

required

Specifies whether subsequent rules should be processed in the event of a match

Language

Credentials

Header


xxxxxxxxxx
1
import wppro from '@api/wppro';
2
3
wppro.siteRulesGet({site_id: 'site_id'})
4
  .then(({ data }) => console.log(data))
5
  .catch(err => console.error(err));


xxxxxxxxxx
26
}
1
{
2
  "success": true,
3
  "message": "string",
4
  "result": {
5
    "count": 0,
6
    "rules": [
7
      {
8
        "hash": "string",
9
        "filter": "request_filter",
10
        "scope": "CDN",
11
        "priority": 100,
12
        "expression": "string",
13
        "action": "allow",
14
        "instructions": [
15
          {
16
            "hash": "string",
17
            "instruction": "cache",
18
            "value": "string"
19
          }
20
        ],
21
        "enabled": true,
22
        "skip": true
23
      }
24
    ]
25
  }

200List of site rules