{ "$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-host-info-in-config-schema.json", "title": "host-info-in-config", "description": "Contains the list of hostnames available for protection and its details.", "type": "object", "properties": { "availableSet": { "description": "The available hosts set for the current user.", "items": { "additionalProperties": false, "description": "Contains details about the hostname and its status.", "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" ], "type": "object", "x-akamai": { "file-path": "schemas/hostname-object.yaml" } }, "type": "array" }, "configId": { "description": "Uniquely identifies the security configuration.", "type": "integer" }, "configVersion": { "description": "The security configuration version.", "type": "integer" }, "errorSet": { "description": "The requested hosts aren't available in this configuration version.", "items": { "additionalProperties": false, "properties": { "hostname": { "description": "The hostname that triggers an error.", "type": "string" }, "reason": { "description": "The reason why the hosts aren't protectable in this configuration version.", "type": "string" }, "reasonCode": { "description": "The error status code for the hostname.", "type": "integer" } }, "required": [ "reason", "reasonCode", "hostname" ], "type": "object" }, "type": "array" }, "protectARLInclusionHost": { "description": "Whether the host defined in the ARL file has legacy WAF enabled in the configuration.", "type": "boolean" }, "selectedSet": { "description": "The selected set of hostnames in this configuration version.", "items": { "additionalProperties": false, "description": "Contains details about the hostname and its status.", "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" ], "type": "object", "x-akamai": { "file-path": "schemas/hostname-object.yaml" } }, "type": "array" } }, "required": [ "configId", "configVersion", "protectARLInclusionHost" ], "additionalProperties": false }