Akamai · Schema

attack-payload-logging-get-200

The GET Response JSON for attack payload logging.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name Type Description
enabled boolean Whether attack payload logging is enabled.
requestBody object The settings for how Akamai's network logs attack payloads in request bodies.
responseBody object The settings for how Akamai's network logs attack payloads in response bodies.
View JSON Schema on GitHub

JSON Schema

appsec-attack-payload-logging-get-200-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai/main/json-schema/appsec-attack-payload-logging-get-200-schema.json",
  "title": "attack-payload-logging-get-200",
  "additionalProperties": false,
  "description": "The GET Response JSON for attack payload logging.",
  "properties": {
    "enabled": {
      "description": "Whether attack payload logging is enabled.",
      "type": "boolean"
    },
    "requestBody": {
      "additionalProperties": false,
      "description": "The settings for how Akamai's network logs attack payloads in request bodies.",
      "properties": {
        "type": {
          "description": "Use `ATTACK_PAYLOAD` to log attack payloads for all requests, or use `NONE` if you don't want to log the attack payloads. Note that when set to `NONE`, you'll see `redacted` in the logging information instead of a blank space or sensitive information. For example, `JSON_PAIRS:redacted`.",
          "enum": [
            "ATTACK_PAYLOAD",
            "NONE"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object",
      "x-akamai": {
        "file-path": "schemas/attack-payload-logging.yaml"
      }
    },
    "responseBody": {
      "additionalProperties": false,
      "description": "The settings for how Akamai's network logs attack payloads in response bodies.",
      "properties": {
        "type": {
          "description": "Use `ATTACK_PAYLOAD` to log attack payloads for all requests, or use `NONE` if you don't want to log the attack payloads. Note that when set to `NONE`, you'll see `redacted` in the logging information instead of a blank space or sensitive information. For example, `JSON_PAIRS:redacted`.",
          "enum": [
            "ATTACK_PAYLOAD",
            "NONE"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object",
      "x-akamai": {
        "file-path": "schemas/attack-payload-logging.yaml"
      }
    }
  },
  "required": [
    "enabled",
    "requestBody",
    "responseBody"
  ],
  "type": "object",
  "x-akamai": {
    "file-path": "schemas/attack-payload-logging-get-200.yaml"
  }
}