Sign in

v32

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

Retrieve a domains's custom rules

Extracts a list of custom rules assigned to a domain, offering filter, ordering, and pagination capabilities

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

Path parameters

domain_idinteger required

The domain ID

The domain ID

Query parameters

ordering'id' | 'name' | 'description' | 'enabled' | 'action' | '-id' | '-name' | '-description' | '-enabled' | '-action' 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

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"
        }
      },
      "conditions": [
        {
          "url": {
            "url": "/wp-admin/"
          },
          "user_agent": {
            "user_agent": "curl/"
          },
          "header": {
            "header": "Origin"
          },
          "header_exists": {
            "header": "Origin"
          },
          "file_extension": {
            "file_extension": [
              "pdf"
            ]
          },
          "content_type": {
            "content_type": [
              "application/xml"
            ]
          },
          "organization": {
            "organization": "UptimeRobot s.r.o"
          },
          "request_rate": {
            "path_pattern": "/"
          }
        }
      ]
    }
  ]
}