Akamai · Schema

attack-payload-logging-put

The PUT Request JSON for attack payload logging.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name Type Description
enabled boolean Whether attack payload logging is enabled.
requestBody object Settings for request body.
responseBody object Settings for response body.
View JSON Schema on GitHub

JSON Schema

appsec-attack-payload-logging-put-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-put-schema.json",
  "title": "attack-payload-logging-put",
  "additionalProperties": false,
  "description": "The PUT Request JSON for attack payload logging.",
  "properties": {
    "enabled": {
      "description": "Whether attack payload logging is enabled.",
      "type": "boolean"
    },
    "requestBody": {
      "additionalProperties": false,
      "description": "Settings for request body.",
      "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": "Settings for response body.",
      "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-put.yaml"
  }
}