akamai-api-security/json-schema/api-security-attack-payload-logging-put-schema.json at main · api-evangelist/akamai-api-security · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai-api-security/refs/heads/main/json-schema/api-security-attack-payload-logging-put-schema.json",
  "title": "attack-payload-logging-put",
  "description": "The PUT Request JSON for attack payload logging.",
  "type": "object",
  "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"
  ],
  "additionalProperties": false
}