Skip to main content
PATCH
/
shield
/
waf
/
custom-rule
/
{id}
cURL
curl --request PATCH \
  --url https://api.bunny.net/shield/waf/custom-rule/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "ruleName": "<string>",
  "ruleDescription": "<string>",
  "ruleConfiguration": {
    "actionType": 1,
    "variableTypes": {
      "REQUEST_URI": "<string>",
      "REQUEST_URI_RAW": "<string>",
      "ARGS": "<string>",
      "ARGS_COMBINED_SIZE": "<string>",
      "ARGS_GET": "<string>",
      "ARGS_GET_NAMES": "<string>",
      "ARGS_POST": "<string>",
      "ARGS_POST_NAMES": "<string>",
      "FILES_NAMES": "<string>",
      "GEO": "<string>",
      "REMOTE_ADDR": "<string>",
      "QUERY_STRING": "<string>",
      "REQUEST_BASENAME": "<string>",
      "REQUEST_BODY": "<string>",
      "REQUEST_COOKIES_NAMES": "<string>",
      "REQUEST_COOKIES": "<string>",
      "REQUEST_FILENAME": "<string>",
      "REQUEST_HEADERS_NAMES": "<string>",
      "REQUEST_HEADERS": "<string>",
      "REQUEST_LINE": "<string>",
      "REQUEST_METHOD": "<string>",
      "REQUEST_PROTOCOL": "<string>",
      "RESPONSE_BODY": "<string>",
      "RESPONSE_HEADERS": "<string>",
      "RESPONSE_STATUS": "<string>"
    },
    "operatorType": 0,
    "severityType": 0,
    "transformationTypes": [
      1
    ],
    "value": "<string>",
    "chainedRuleConditions": [
      {
        "variableTypes": {
          "REQUEST_URI": "<string>",
          "REQUEST_URI_RAW": "<string>",
          "ARGS": "<string>",
          "ARGS_COMBINED_SIZE": "<string>",
          "ARGS_GET": "<string>",
          "ARGS_GET_NAMES": "<string>",
          "ARGS_POST": "<string>",
          "ARGS_POST_NAMES": "<string>",
          "FILES_NAMES": "<string>",
          "GEO": "<string>",
          "REMOTE_ADDR": "<string>",
          "QUERY_STRING": "<string>",
          "REQUEST_BASENAME": "<string>",
          "REQUEST_BODY": "<string>",
          "REQUEST_COOKIES_NAMES": "<string>",
          "REQUEST_COOKIES": "<string>",
          "REQUEST_FILENAME": "<string>",
          "REQUEST_HEADERS_NAMES": "<string>",
          "REQUEST_HEADERS": "<string>",
          "REQUEST_LINE": "<string>",
          "REQUEST_METHOD": "<string>",
          "REQUEST_PROTOCOL": "<string>",
          "RESPONSE_BODY": "<string>",
          "RESPONSE_HEADERS": "<string>",
          "RESPONSE_STATUS": "<string>"
        },
        "operatorType": 0,
        "value": "<string>"
      }
    ]
  }
}
'
{
  "id": 123,
  "shieldZoneId": 123,
  "userId": "<string>",
  "ruleName": "<string>",
  "ruleDescription": "<string>",
  "ruleJson": "<string>",
  "ruleConfiguration": {
    "actionType": 1,
    "variableTypes": {
      "REQUEST_URI": "<string>",
      "REQUEST_URI_RAW": "<string>",
      "ARGS": "<string>",
      "ARGS_COMBINED_SIZE": "<string>",
      "ARGS_GET": "<string>",
      "ARGS_GET_NAMES": "<string>",
      "ARGS_POST": "<string>",
      "ARGS_POST_NAMES": "<string>",
      "FILES_NAMES": "<string>",
      "GEO": "<string>",
      "REMOTE_ADDR": "<string>",
      "QUERY_STRING": "<string>",
      "REQUEST_BASENAME": "<string>",
      "REQUEST_BODY": "<string>",
      "REQUEST_COOKIES_NAMES": "<string>",
      "REQUEST_COOKIES": "<string>",
      "REQUEST_FILENAME": "<string>",
      "REQUEST_HEADERS_NAMES": "<string>",
      "REQUEST_HEADERS": "<string>",
      "REQUEST_LINE": "<string>",
      "REQUEST_METHOD": "<string>",
      "REQUEST_PROTOCOL": "<string>",
      "RESPONSE_BODY": "<string>",
      "RESPONSE_HEADERS": "<string>",
      "RESPONSE_STATUS": "<string>"
    },
    "operatorType": 0,
    "severityType": 0,
    "transformationTypes": [
      1
    ],
    "value": "<string>",
    "chainedRuleConditions": [
      {
        "variableTypes": {
          "REQUEST_URI": "<string>",
          "REQUEST_URI_RAW": "<string>",
          "ARGS": "<string>",
          "ARGS_COMBINED_SIZE": "<string>",
          "ARGS_GET": "<string>",
          "ARGS_GET_NAMES": "<string>",
          "ARGS_POST": "<string>",
          "ARGS_POST_NAMES": "<string>",
          "FILES_NAMES": "<string>",
          "GEO": "<string>",
          "REMOTE_ADDR": "<string>",
          "QUERY_STRING": "<string>",
          "REQUEST_BASENAME": "<string>",
          "REQUEST_BODY": "<string>",
          "REQUEST_COOKIES_NAMES": "<string>",
          "REQUEST_COOKIES": "<string>",
          "REQUEST_FILENAME": "<string>",
          "REQUEST_HEADERS_NAMES": "<string>",
          "REQUEST_HEADERS": "<string>",
          "REQUEST_LINE": "<string>",
          "REQUEST_METHOD": "<string>",
          "REQUEST_PROTOCOL": "<string>",
          "RESPONSE_BODY": "<string>",
          "RESPONSE_HEADERS": "<string>",
          "RESPONSE_STATUS": "<string>"
        },
        "operatorType": 0,
        "value": "<string>"
      }
    ]
  },
  "errorResponse": {
    "statusCode": 100,
    "success": true,
    "message": "<string>",
    "errorKey": "<string>"
  }
}

Path Parameters

​
id
integer<int32>
required

The ID of the Custom WAF Rule you would like to update.

Body

​
ruleName
string | null
​
ruleDescription
string | null
​
ruleConfiguration
object

Response

OK

​
id
integer<int64>
​
shieldZoneId
integer<int64>
​
userId
string | null
​
ruleName
string | null
​
ruleDescription
string | null
​
ruleJson
string | null
​
ruleConfiguration
object
​
errorResponse
object

Generic response object containing status information for API operations.