Akamai API Security · JSON Structure

Api Security Logging Header Setting Structure

The header settings for HTTP Header Logging.

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

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

Properties

type values

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-header-setting-structure.json",
  "name": "logging-header-setting",
  "description": "The header settings for HTTP Header Logging.",
  "type": "object",
  "properties": {
    "type": {
      "description": "Use `all` to log headers for all requests with any standard header. Use `none` to exclude headers for any requests with any standard header from logging. Use `exclude` to exclude headers for requests with specific standard headers. Use `only` to include headers for requests with specific standard headers.",
      "enum": [
        "all",
        "none",
        "exclude",
        "only"
      ],
      "type": "string"
    },
    "values": {
      "description": "List of headers to include or exclude depending on the `type` setting.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false
}