custom-denies

{
  "$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-custom-denies-schema.json",
  "title": "custom-denies",
  "description": "Contains details about custom deny actions.",
  "type": "object",
  "properties": {
    "ratePolicies": {
      "description": "A list of custom deny actions in this configuration version.",
      "items": {
        "additionalProperties": false,
        "description": "Contains details about a custom deny action.",
        "properties": {
          "description": {
            "description": "Describes the custom deny action.",
            "type": "string"
          },
          "id": {
            "description": "__Read-only__ Uniquely identifies the custom deny action.",
            "readOnly": true,
            "type": "string"
          },
          "name": {
            "description": "The name you assigned to the custom deny action.",
            "type": "string"
          },
          "parameters": {
            "description": "Describes the custom deny parameters.",
            "items": {
              "additionalProperties": false,
              "description": "Contains a list of parameters for the custom deny action. These parameters are not the same type of parameters you usually include in the path of a request.",
              "properties": {
                "displayName": {
                  "description": "The description of the custom deny parameter.",
                  "type": "string"
                },
                "name": {
                  "description": "The custom deny parameter you choose instead of the Akamai default response. For available values, see [Deny name values](https://techdocs.akamai.com/application-security/reference/deny-name-values).",
                  "enum": [
                    "response_status_code",
                    "prevent_browser_cache",
                    "response_content_type",
                    "response_body_content",
                    "response_header_name",
                    "response_header_value",
                    "custom_deny_hostname",
                    "custom_deny_path",
                    "include_true_ip",
                    "include_reference_id"
                  ],
                  "type": "string"
                },
                "value": {
                  "description": "The value you assign to the custom deny parameter. For available values, see [Deny name values](https://techdocs.akamai.com/application-security/reference/deny-name-values).",
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "type": "array"
          }
        },
        "required": [
          "name",
          "parameters"
        ],
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/custom-deny.yaml"
        }
      },
      "type": "array"
    }
  },
  "additionalProperties": false
}