Akamai API Security · JSON Structure

Api Security Logging Option Structure

Condition to be logged.

Type: object Properties: 3 Required: 1
API DiscoveryAPI SecurityCloud SecurityPosture ManagementRuntime ProtectionThreat Protection

logging-option is a JSON Structure definition published by Akamai API Security, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name value

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai-api-security/refs/heads/main/json-structure/api-security-logging-option-structure.json",
  "name": "logging-option",
  "description": "Condition to be logged.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identifier for each logging option. See [Logging option values](https://techdocs.akamai.com/application-security/reference/logging-option-values).",
      "enum": [
        "CLIENT_TLS_FINGERPRINT_MATCH",
        "HEADER_ORDER_MATCH",
        "REQUEST_HEADER_MATCH",
        "COOKIE_MATCH",
        "URI_QUERY_MATCH",
        "ARGS_POST_MATCH"
      ],
      "type": "string"
    },
    "name": {
      "description": "A description of the logging option type.",
      "type": "string"
    },
    "value": {
      "description": "The value on which to match when determining whether to log the custom rule condition.",
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}