v32

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

Custom Rules

Update a custom rule

Only properties present in the request will be updated

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

Path parameters

domain_idinteger required

The domain ID

rule_idinteger required

The custom rule ID

Request body

namestring nullable

The name assigned to the rule

descriptionstring nullable

The description assigned to the rule

enabledboolean nullable

Whether or not the rule is enabled

Example request

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

Response

Successful Response