Akamai · Schema

malware-policies

Contains details about malware policies.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name Type Description
malwarePolicies array A list of malware policies in this configuration version.
View JSON Schema on GitHub

JSON Schema

akamai-malware-policies-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/malware-policies",
  "title": "malware-policies",
  "additionalProperties": false,
  "description": "Contains details about malware policies.",
  "properties": {
    "malwarePolicies": {
      "description": "A list of malware policies in this configuration version.",
      "items": {
        "additionalProperties": false,
        "description": "Contains details about a malware policy.",
        "properties": {
          "allowListId": {
            "description": "The ID of a client list containing file hashes of specific files to allow.",
            "type": "string"
          },
          "blockListId": {
            "description": "The ID of a client list containing file hashes of specific files to block.",
            "type": "string"
          },
          "contentTypes": {
            "description": "The content types and encodings to match.",
            "items": {
              "additionalProperties": false,
              "properties": {
                "encodedContentAttributes": {
                  "description": "An optional list of encoded attribute paths.",
                  "items": {
                    "additionalProperties": false,
                    "properties": {
                      "encoding": {
                        "description": "The encodings used for the attribute path. Currently only `base64` is supported.",
                        "items": {
                          "enum": [
                            "base64"
                          ],
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "path": {
                        "description": "The JSONPath to an attribute with encoded content. The path must point to a single item, and may not include the `$`, `..`, `?` or `*` operators.",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                },
                "name": {
                  "description": "The name of the content type.",
                  "type": "string"
                }
              },
              "required": [
                "name"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "description": {
            "description": "Descriptive text you provide about a policy.",
            "type": "string"
          },
          "hostnames": {
            "description": "The hostnames to match. This is where you want the malware detections to focus.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "id": {
            "description": "__Read-only__ Uniquely identifies each malware policy.",
            "readOnly": true,
            "type": "integer"
          },
          "logFilename": {
            "default": false,
            "description": "Whether to log the name of the file that triggered an `alert` or `deny` action.",
            "type": "boolean"
          },
          "name": {
            "description": "The name you assign to a malware policy.",
            "type": "string"
          },
          "paths": {
            "description": "The paths to match. You can use the `?` and `*` wildcards anywhere in a path.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "name",
          "hostnames",
          "paths"
        ],
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/malware-policy.yaml"
        }
      },
      "type": "array"
    }
  },
  "required": [
    "malwarePolicies"
  ],
  "type": "object",
  "x-akamai": {
    "file-path": "schemas/malware-policies.yaml"
  }
}