Modify the penalty box conditions in evaluation mode

put https://{hostname}/appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-penalty-box/conditions

Modifies the penalty box condition settings for a security policy in evaluation mode.

Responses

Response body

object

conditionOperator

string

required

The logic to apply to a set of penalty box conditions: either OR to satisfy any condition, or AND to satisfy all conditions.

AND OR

conditions

array of objects

required

length ≥ 0

The conditions list for the penalty box.

conditions*

object

caseSensitive

boolean

Whether to consider the case-sensitivity of the provided query parameter value. This only applies to the uriQueryMatch condition type.

clientLists

array of strings

length ≥ 0

The clientLists that trigger the condition. This only applies to the clientListMatch condition type.

clientLists

extensions

array of strings

The file extensions that trigger the condition. This only applies to the extensionMatch condition type.

extensions

filenames

array of strings

The filenames that trigger the condition. This only applies to the filenameMatch condition type.

filenames

header

string

The HTTP header that triggers the condition. This only applies to the requestHeaderMatch condition type.

hosts

array of strings

The hostnames that trigger the condition. This only applies to the hostMatch condition type.

hosts

ips

array of strings

The IPs that trigger the condition. This only applies to the ipMatch condition type.

ips

methods

array of strings

The HTTP request methods that trigger the condition. The possible values are GET, POST, HEAD, PUT, DELETE, OPTIONS, TRACE, CONNECT and PATCH. This only applies to the requestMethodMatch condition type.

methods

name

string

The query parameter name that triggers the condition. This only applies to the uriQueryMatch condition type.

nameCase

boolean

Whether to consider the case-sensitivity of the provided query parameter name. This only applies to the uriQueryMatch condition type.

paths

array of strings

The paths that trigger the condition. This only applies to the pathMatch condition type.

paths

positiveMatch

boolean

required

Whether the condition should trigger on a match (true) or a lack of match (false).

type

string

required

The condition type to match on. See Export condition type values.

hostMatch pathMatch filenameMatch extensionMatch uriQueryMatch ipMatch requestMethodMatch requestHeaderMatch clientListMatch

useHeaders

boolean

Whether the condition should include X-Forwarded-For (XFF) header. This applies to the ipMatch and clientListMatch condition type.

value

string

The query parameter value if the condition type is uriQueryMatch and header value if the condition type is requestHeaderMatch. This only applies when the condition type is uriQueryMatch or requestHeaderMatch.

valueCase

boolean

Whether to consider the case-sensitivity of the provided header value. This only applies to the requestHeaderMatch condition type.

valueWildcard

boolean

Whether the provided header value is a wildcard. This only applies to the requestHeaderMatch condition type.

wildcard

boolean

Whether the provided query parameter value is a wildcard. This only applies to the uriQueryMatch condition type.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://hostname/appsec/v1/configs/configId/versions/versionNumber/security-policies/policyId/eval-penalty-box/conditions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "conditionOperator": "AND"
8
}
9
'


xxxxxxxxxx
20
 
1
{
2
  "conditionOperator": "AND",
3
  "conditions": [
4
    {
5
      "filenames": [
6
        "hh"
7
      ],
8
      "positiveMatch": true,
9
      "type": "filenameMatch"
10
    },
11
    {
12
      "clientLists": [
13
        "88331_TESTGEO1"
14
      ],
15
      "positiveMatch": true,
16
      "type": "clientListMatch",
17
      "useHeaders": true
18
    }
19
  ]
20
}

200Successfully updated penalty box conditions for the security policy in evaluation mode.

400Invalid. Client error, such as invalid or malformed input.

403Forbidden. You don't have permission to write to this resource.

404Not found. The named security policy doesn't exist, doesn't carry application layer controls, or no rule with this ID is available for use in this policy.

500Internal server error. Something went wrong on our side. Try again in a few minutes, and contact support if the error persists.