Akamai API Security · JSON Structure

Api Security Hostnames Structure

Contains a list of selected hostnames for the specified configuration version.

Type: object Properties: 2 Required: 1
API DiscoveryAPI SecurityCloud SecurityPosture ManagementRuntime ProtectionThreat Protection

hostnames is a JSON Structure definition published by Akamai API Security, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

hostnameList mode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai-api-security/refs/heads/main/json-structure/api-security-hostnames-structure.json",
  "name": "hostnames",
  "description": "Contains a list of selected hostnames for the specified configuration version.",
  "type": "object",
  "properties": {
    "hostnameList": {
      "description": "The list of hostnames for a configuration version.",
      "items": {
        "additionalProperties": false,
        "properties": {
          "hostname": {
            "description": "The hostname on which to match the request.",
            "type": "string"
          }
        },
        "required": [
          "hostname"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "mode": {
      "description": "The type of update you want to make to the evaluation hostname list. Use `append` to add additional hostnames, `remove` to delete the hostnames from the list, or `replace` to replace the existing list with the hostnames you pass in your request.",
      "enum": [
        "append",
        "remove",
        "replace"
      ],
      "type": "string"
    }
  },
  "required": [
    "hostnameList"
  ],
  "additionalProperties": false
}