Akamai API Security · Schema

hostname-object

Contains details about the hostname and its status.

API DiscoveryAPI SecurityCloud SecurityPosture ManagementRuntime ProtectionThreat Protection

Properties

Name Type Description
activeInProduction boolean Whether the hostname is active in the production network.
activeInStaging boolean Whether the hostname is active in the staging network.
arlInclusion boolean Whether the hostname is Akamai Resource Locator (ARL) included.
configIdInProduction integer Uniquely identifies the configuration that protects the hostname.
configNameInProduction string The name of the configuration that protects the hostname.
hostname string The hostname.
View JSON Schema on GitHub

JSON Schema

api-security-hostname-object-schema.json Raw ↑ 
{
  "$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-hostname-object-schema.json",
  "title": "hostname-object",
  "description": "Contains details about the hostname and its status.",
  "type": "object",
  "properties": {
    "activeInProduction": {
      "description": "Whether the hostname is active in the production network.",
      "type": "boolean"
    },
    "activeInStaging": {
      "description": "Whether the hostname is active in the staging network.",
      "type": "boolean"
    },
    "arlInclusion": {
      "description": "Whether the hostname is Akamai Resource Locator (ARL) included.",
      "type": "boolean"
    },
    "configIdInProduction": {
      "description": "Uniquely identifies the configuration that protects the hostname.",
      "nullable": true,
      "type": "integer"
    },
    "configNameInProduction": {
      "description": "The name of the configuration that protects the hostname.",
      "nullable": true,
      "type": "string"
    },
    "hostname": {
      "description": "The hostname.",
      "type": "string"
    }
  },
  "required": [
    "hostname"
  ],
  "additionalProperties": false
}