Akamai · Schema

header-logging-get-200

The GET Response JSON for HTTP Header Logging.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name Type Description
allowSampling boolean Enables HTTP Header logging.
cookies object Settings for cookie headers.
customHeaders object Settings for custom headers.
standardHeaders object Settings for standard headers.
View JSON Schema on GitHub

JSON Schema

akamai-header-logging-get-200-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/header-logging-get-200",
  "title": "header-logging-get-200",
  "additionalProperties": false,
  "description": "The GET Response JSON for HTTP Header Logging.",
  "properties": {
    "allowSampling": {
      "description": "Enables HTTP Header logging.",
      "type": "boolean"
    },
    "cookies": {
      "additionalProperties": false,
      "description": "Settings for cookie headers.",
      "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"
      ],
      "type": "object",
      "x-akamai": {
        "file-path": "schemas/logging-header-setting.yaml"
      }
    },
    "customHeaders": {
      "additionalProperties": false,
      "description": "Settings for custom headers.",
      "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"
      ],
      "type": "object",
      "x-akamai": {
        "file-path": "schemas/logging-header-setting.yaml"
      }
    },
    "standardHeaders": {
      "additionalProperties": false,
      "description": "Settings for standard headers.",
      "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"
      ],
      "type": "object",
      "x-akamai": {
        "file-path": "schemas/logging-header-setting.yaml"
      }
    }
  },
  "required": [
    "allowSampling",
    "cookies",
    "customHeaders",
    "standardHeaders"
  ],
  "type": "object",
  "x-akamai": {
    "file-path": "schemas/header-logging-get-200.yaml"
  }
}