Akamai API Security · JSON Structure

Api Security Hostname Object Structure

Contains details about the hostname and its status.

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

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

Properties

activeInProduction activeInStaging arlInclusion configIdInProduction configNameInProduction hostname

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-hostname-object-structure.json",
  "name": "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": "int32"
    },
    "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
}