ApiViolation

ApiViolation

JSON Example

{
    "action": "string",
    "match_element_location": "string",
    "match_element_name": "string",
    "match_element_value": "string",
    "message_parameters": [
        "string"
    ],
    "violation_type": "string"
}

string

action

Optional

Action performed based on this violation, such as flag or reject. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

match_element_location

Optional

Location where the API violation was detected, such as path, query args, or request body. Enum options - API_LOCATION_UNSPECIFIED, API_LOCATION_PATH, API_LOCATION_METHOD, API_LOCATION_QUERY_ARGS, API_LOCATION_REQUEST_HEADER, API_LOCATION_REQUEST_CONTENT_TYPE, API_LOCATION_REQUEST_BODY, API_LOCATION_RESPONSE_STATUS_CODE, API_LOCATION_RESPONSE_HEADER, API_LOCATION_RESPONSE_CONTENT_TYPE, API_LOCATION_RESPONSE_BODY, API_LOCATION_WAF. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

match_element_name

Optional

Name of the element that caused the violation, for example 'id'. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

match_element_value

Optional

Value of the element that caused the violation, for example '42'. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

message_parameters

Optional

List of parameters to be substituted into the message format string. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

violation_type

Optional

The type of violation (e.g. invalid type, missing required property). Enum options - API_VIOLATION_TYPE_NONE, API_VIOLATION_TYPE_INVALID_TYPE, API_VIOLATION_TYPE_VALUE_OUT_OF_RANGE, API_VIOLATION_TYPE_FORMAT_MISMATCH, API_VIOLATION_TYPE_UNEXPECTED_ADDITIONAL_PROPERTY, API_VIOLATION_TYPE_MISSING_REQUIRED_PROPERTY, API_VIOLATION_TYPE_NON_API_REQUEST, API_VIOLATION_TYPE_SHADOW_ENDPOINT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of

ApiLog