EdgeVirtualServiceHttpSecurityRule

EdgeVirtualServiceHttpSecurityRule
EdgeVirtualServiceHttpSecurityRule

Defines a HTTP security rule. It consists of a match criteria along with the actions to execute once the criteria is satisfied. If the match criteria is not set, defined actions will be be executed for all requests.

JSON Example
{
    "name": "string",
    "active": false,
    "logging": false,
    "matchCriteria": {
        "clientIpMatch": {
            "matchCriteria": "string",
            "addresses": [
                "string"
            ]
        },
        "servicePortMatch": {
            "matchCriteria": "string",
            "ports": [
                0
            ]
        },
        "methodMatch": {
            "matchCriteria": "string",
            "methods": [
                "string"
            ]
        },
        "protocol": "string",
        "pathMatch": {
            "matchCriteria": "string",
            "matchStrings": [
                "string"
            ]
        },
        "queryMatch": [
            "string"
        ],
        "headerMatch": [
            {
                "matchCriteria": "string",
                "value": [
                    "string"
                ],
                "key": "string"
            }
        ],
        "cookieMatch": {
            "matchCriteria": "string",
            "key": "string",
            "value": "string"
        }
    },
    "allowOrCloseConnectionAction": "string",
    "rateLimitAction": {
        "count": 0,
        "period": 0,
        "closeConnectionAction": "string",
        "redirectAction": {
            "statusCode": 0
        },
        "localResponseAction": {
            "statusCode": 0,
            "contentType": "string",
            "content": "string"
        }
    },
    "redirectToHttpsAction": {
        "port": 0
    },
    "localResponseAction": {
        "statusCode": 0,
        "contentType": "string",
        "content": "string"
    }
}
string As ^(?!\s+$).+
name
Required

Name of the rule. Must be non-blank and fewer than 1000 characters.

boolean
active
Optional

Whether the rule is active or not.

boolean
logging
Optional

Whether to enable logging on rule match or not.

matchCriteria
Optional

Defines a HTTP security match criteria. If multiple matches are configured, it is treated as logically AND operation. All match types must be true for the security match criteria to be satisfied.

string As ^(?!\s+$).+
allowOrCloseConnectionAction
Optional

Action to allow the incoming request or close the connection. It cannot be configured in combination with other actions. Allowed values are:

  • ALLOW - Allow the incoming request.
  • CLOSE - Close the incoming connection.
rateLimitAction
Optional

Defines the action to apply rate limit on incoming requests. It consists of rate limiting properties and one of the actions to execute upon reaching rate limit. If not actions are provided, rate limiting will only be reported.

redirectToHttpsAction
Optional

Defines the action to redirect the incoming request to HTTPS.

localResponseAction
Optional

Defines the action to send a local HTTP response.

Availability
Added in 38.0