ApiLog

ApiLog

JSON Example

{
    "action": "string",
    "effective_labels": "string",
    "enabled_api_checks": [
        "string"
    ],
    "executed_api_labels_str": "string",
    "omitted_api_violations": 0,
    "request_type": "string",
    "violations": [
        {
            "action": "string",
            "match_element_location": "string",
            "match_element_name": "string",
            "match_element_value": "string",
            "message_parameters": [
                "string"
            ],
            "violation_type": "string"
        }
    ]
}

string

action

Optional

Overall action taken based on the API violations. 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

effective_labels

Optional

Comma-separated WAAP label names effective for this request. Populated only when the request's LabelProfile has log_labels enabled. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

enabled_api_checks

Optional

List of API validation checks that were performed on this request. Enum options - API_LOG_CHECK_UNSPECIFIED, API_LOG_CHECK_PATH_PARAMETER, API_LOG_CHECK_QUERY_PARAMETER, API_LOG_CHECK_REQUEST_CONTENT_TYPE, API_LOG_CHECK_REQUEST_BODY, API_LOG_CHECK_RESPONSE_STATUS_CODE, API_LOG_CHECK_RESPONSE_CONTENT_TYPE, API_LOG_CHECK_REQUEST_HEADER. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

executed_api_labels_str

Optional

Comma-separated list of API policy labels that were executed for this request. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

omitted_api_violations

Optional

Number of API violations that were not logged due to space constraints. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

request_type

Optional

Constraints: default: API_LOG_TYPE_OTHER

The type of the API request. Enum options - API_LOG_TYPE_OTHER, API_LOG_TYPE_ACTIVE, API_LOG_TYPE_SHADOW, API_LOG_TYPE_ZOMBIE, API_LOG_TYPE_ORPHAN. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of ApiViolation

violations

Optional

List of API violations detected during validation. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of

ApplicationLog