v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Advanced Rules

Retrieve advanced rules

Retrieve a list of advanced rules assigned to a domain, offering filter, ordering, and pagination capabilities

get/waap/v1/domains/{domain_id}/advanced-rules

Path parameters

domain_idinteger required

The domain ID

The domain ID

Query parameters

ordering'id' | 'name' | 'description' | 'enabled' | 'action' | 'phase' | '-id' | '-name' | '-description' | '-enabled' | '-action' | '-phase' nullable

Determine the field to order results by

Example:-id

Determine the field to order results by

limitinteger

Number of items to return

Number of items to return

offsetinteger

Number of items to skip

Number of items to skip

namestring

Filter rules based on their name. Supports '*' as a wildcard character.

Example:Block by specific IP rule

Filter rules based on their name. Supports '*' as a wildcard character.

descriptionstring

Filter rules based on their description. Supports '*' as a wildcard character.

Example:This rule blocks all the requests coming form a specific IP address

Filter rules based on their description. Supports '*' as a wildcard character.

action'allow' | 'block' | 'captcha' | 'handshake' | 'monitor' | 'tag'

Filter to refine results by specific actions

enabledboolean

Filter rules based on their active status

Filter rules based on their active status

phase'access' | 'header_filter' | 'body_filter'

Filter rules based on the WAAP request/response phase for applying the rule.

The "access" phase is responsible for modifying the request before it is sent to the origin server.

The "header_filter" phase is responsible for modifying the HTTP headers of a response before they are sent back to the client.

The "body_filter" phase is responsible for modifying the body of a response before it is sent back to the client.

Example:access

Filter rules based on the WAAP request/response phase for applying the rule.

The "access" phase is responsible for modifying the request before it is sent to the origin server.

The "header_filter" phase is responsible for modifying the HTTP headers of a response before they are sent back to the client.

The "body_filter" phase is responsible for modifying the body of a response before it is sent back to the client.

Response

Successful Response

limitinteger required

Number of items requested in the response

offsetinteger required

Items response offset used

countinteger required

Number of items contain in the response

Example response

{
  "results": [
    {
      "name": "Block foobar bot",
      "action": {
        "block": {
          "action_duration": "12h"
        }
      },
      "source": "request.rate_limit([], '.*events', 5, 200, [], [], '', 'ip') and not ('mb-web-ui' in request.headers['Cookie'] or 'mb-mobile-ios' in request.headers['Cookie'] or 'session-token' in request.headers['Cookie']) and not request.headers['session']"
    }
  ]
}