v32

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

Custom Rules

Retrieve a specific custom rule

Extracts a specific custom rule assigned to a domain

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

Path parameters

domain_idinteger required

The domain ID

rule_idinteger required

The custom rule ID

Response

Successful Response

namestring required

The name assigned to the rule

descriptionstring

The description assigned to the rule

enabledboolean required

Whether or not the rule is enabled

idinteger required

The unique identifier for the rule

Example response

{
  "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": "/"
      }
    }
  ]
}