{ "components": { "parameters": { "gid-query": { "description": "A unique identifier for the group. If your GTM client credential has access to more than one group, you need to specify which group to assign to the domain. For more information, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "in": "query", "name": "gid", "schema": { "example": 15166, "type": "integer" }, "x-akamai": { "file-path": "parameters/gid-query.yaml" } } }, "schemas": { "identity-contracts-response": { "additionalProperties": false, "description": "Contracts under a specific GTM account.", "properties": { "accountId": { "description": "A unique identifier for the account where the contract exists.", "type": "string" }, "contracts": { "description": "Contracts under a specific account.", "items": { "additionalProperties": false, "properties": { "contractId": { "description": "A unique identifier for the contract.", "type": "string" }, "contractName": { "description": "A descriptive name for the contract.", "type": "string" }, "contractTypeName": { "description": "A descriptive name for the contract type.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/identity-contracts-response.yaml" } }, "identity-groups-response": { "additionalProperties": false, "description": "Groups under a specific GTM account.", "properties": { "groups": { "description": "Groups under a specific GTM account. For details on how to modify group permissions, see the [Identity Management: User Administration API](https://techdocs.akamai.com/iam-user-admin/reference/api).", "items": { "additionalProperties": false, "properties": { "contractIds": { "description": "Unique identifiers for the contracts associated with the group.", "items": { "type": "string" }, "type": "array" }, "groupId": { "description": "A unique identifier for the group.", "type": "integer" }, "groupName": { "description": "A descriptive name for the group.", "type": "string" }, "permissions": { "description": "Privileges set for the group. Use these privileges to create a domain, modify, or delete any of the `properties` within a specific domain. Any combination of `READ`, `WRITE`, `ADD`, and `ADD_DATACENTER` values.", "items": { "enum": [ "READ", "WRITE", "ADD", "ADD_DATACENTER" ], "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/identity-groups-response.yaml" } }, "identity-response": { "additionalProperties": false, "description": "High-level information about the API client for a specific GTM account.", "properties": { "accountId": { "description": "A unique API client identity for a specific account, created in [Control Center](https://control.akamai.com/apps/home-page).", "type": "string" }, "active": { "description": "Enabled if the account is active.", "type": "boolean" }, "contracts": { "description": "Contracts under a specific account.", "items": { "additionalProperties": false, "properties": { "contractId": { "description": "A unique identifier for the contract.", "type": "string" }, "features": { "description": "Available property types for a specific domain. Any combination of `FAILOVER`, `RANKED_FAILOVER`, `QTR`, `STATIC`, `ASMAPPING`, `CIDRMAPPING`, `GEOGRAPHIC`, `WEIGHTED_ROUND_ROBIN`, `WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK`, `WEIGHTED_HASHED`, `PERFORMANCE`, `PERFORMANCE_WITH_LOAD_FEEDBACK`, `PERFORMANCE_WITH_LOAD_FEEDBACK_COMPUTED_TARGETS`, and `PERFORMANCE_WITH_LOAD_FEEDBACK_DOWNLOAD_SCORE` values.", "items": { "enum": [ "FAILOVER", "RANKED_FAILOVER", "QTR", "STATIC", "ASMAPPING", "CIDRMAPPING", "GEOGRAPHIC", "WEIGHTED_ROUND_ROBIN", "WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK", "WEIGHTED_HASHED", "PERFORMANCE", "PERFORMANCE_WITH_LOAD_FEEDBACK", "PERFORMANCE_WITH_LOAD_FEEDBACK_COMPUTED_TARGETS", "PERFORMANCE_WITH_LOAD_FEEDBACK_DOWNLOAD_SCORE" ], "type": "string" }, "type": "array" }, "permissions": { "description": "Privileges set for the contract, controlling the ability to modify or delete `properties`. Any combination of `READ`, `WRITE`, `ADD`, and `ADD_DATACENTER` values.", "items": { "enum": [ "READ", "WRITE", "ADD", "ADD_DATACENTER" ], "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "email": { "description": "The email address of the client on the account.", "type": "string" }, "firstName": { "description": "The first name of the client on the account.", "type": "string" }, "lastName": { "description": "The last name of the client on the account.", "type": "string" }, "locale": { "description": "Indicates the client's language and country in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.", "type": "string" }, "userName": { "description": "The username of the client on the account.", "type": "string" }, "userTimeZone": { "description": "The time zone of the client on the account, which specifies an offset from GTM.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/identity-response.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference" }, "info": { "description": "Use load balancing to manage website and mobile performance demands.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Global Traffic Management API", "version": "v1" }, "openapi": "3.0.0", "paths": { "/collections/akamai-cloud-regions": { "get": { "description": "This operation returns a list of available Akamai cloud regions. Use these regions when creating a data center with a `cloudProvider` of `akamai-cloud`. Each region includes geographic metadata such as city, country, latitude, and longitude that you can use to populate data center fields.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-akamai-cloud-regions" }, "operationId": "get-akamai-cloud-regions", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "city": "Newark", "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "continent": "North America", "country": "US", "countryName": "United States", "label": "Newark, NJ, USA", "latitude": 40.7357, "longitude": -74.1724, "stateOrProvince": "NJ" }, { "city": "Frankfurt", "cloud": { "provider": "akamai-cloud", "regionId": "eu-central" }, "continent": "Europe", "country": "DE", "countryName": "Germany", "label": "Frankfurt, DE", "latitude": 50.1109, "longitude": 8.6821, "stateOrProvince": null }, { "city": "Singapore", "cloud": { "provider": "akamai-cloud", "regionId": "ap-southeast" }, "continent": "Asia", "country": "SG", "countryName": "Singapore", "label": "Singapore, SG", "latitude": 1.3521, "longitude": 103.8198, "stateOrProvince": null } ], "schema": { "description": "Available Akamai cloud regions with geographic metadata.", "items": { "additionalProperties": false, "properties": { "city": { "description": "The city where the Akamai cloud region is located.", "type": "string" }, "cloud": { "additionalProperties": false, "description": "Cloud provider details for this region.", "properties": { "provider": { "description": "The cloud provider identifier, `akamai-cloud` or `akamai-metal`.", "enum": [ "akamai-cloud", "akamai-metal" ], "type": "string" }, "regionId": { "description": "The cloud provider's unique identifier for this region.", "type": "string" } }, "type": "object" }, "continent": { "description": "The continent where the Akamai cloud region is located.", "type": "string" }, "country": { "description": "The two-letter ISO 3166-1 country code where the Akamai cloud region is located.", "type": "string" }, "countryName": { "description": "The full name of the country where the Akamai cloud region is located.", "type": "string" }, "label": { "description": "A human-readable label for the Akamai cloud region.", "type": "string" }, "latitude": { "description": "The geographic latitude of the Akamai cloud region.", "format": "float", "type": "number" }, "longitude": { "description": "The geographic longitude of the Akamai cloud region.", "format": "float", "type": "number" }, "stateOrProvince": { "description": "The state or province where the Akamai cloud region is located, if applicable.", "nullable": true, "type": "string" } }, "type": "object" }, "type": "array", "x-akamai": { "file-path": "schemas/akamai-cloud-regions.yaml" } } } }, "description": "Successful response." } }, "summary": "List Akamai cloud regions", "tags": [ "Collections" ] }, "x-akamai": { "file-path": "paths/akamai-cloud-regions.yaml", "path-info": "/collections/akamai-cloud-regions" } }, "/collections/datacenter-ids": { "get": { "description": "Returns a paginated list of valid datacenter IDs available for use as virtual datacenters.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-datacenter-ids" }, "operationId": "get-datacenter-ids", "parameters": [ { "description": "The maximum number of datacenter IDs to return per page. Defaults to `209`.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "required": false, "schema": { "default": 209, "example": 209, "type": "integer" } }, { "description": "The zero-based index of the first datacenter ID to return. Defaults to `0`.", "example": "{{offset}}", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "example": 0, "type": "integer" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ 1, 2, 3, 4, 5, 5400, 5401, 5402 ] }, "schema": { "additionalProperties": false, "description": "A paginated list of valid datacenter IDs available for use as virtual datacenters.", "properties": { "items": { "description": "The list of valid datacenter IDs for the requested page.", "items": { "type": "integer" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-ids.yaml" } } } }, "description": "Successful response." } }, "summary": "List datacenter IDs", "tags": [ "Collections" ] }, "x-akamai": { "file-path": "paths/datacenter-ids.yaml", "path-info": "/collections/datacenter-ids" } }, "/collections/supported-geo-codes": { "get": { "description": "Returns the full hierarchy of supported geographic codes \u2014 continents, countries, and states or provinces \u2014 that you can use when configuring geographic maps.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-supported-geo-codes" }, "operationId": "get-supported-geo-codes", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "continents": [ { "code": "NA", "countries": [ { "code": "US", "name": "United States", "regions": [ { "code": "CA", "name": "California" }, { "code": "NY", "name": "New York" } ] }, { "code": "CA", "name": "Canada", "regions": [ { "code": "ON", "name": "Ontario" } ] } ], "name": "North America" }, { "code": "EU", "countries": [ { "code": "DE", "name": "Germany", "regions": [] } ], "name": "Europe" } ] }, "schema": { "additionalProperties": false, "description": "A hierarchical collection of geographic codes used to configure geographic maps.", "properties": { "continents": { "description": "The list of continents and their nested countries and regions.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The two-letter continent code, for example `NA` for North America.", "type": "string" }, "countries": { "description": "The list of countries within this continent.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The two-letter ISO country code.", "type": "string" }, "name": { "description": "The full name of the country.", "type": "string" }, "regions": { "description": "The list of states, provinces, or regions within this country.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The region code.", "type": "string" }, "name": { "description": "The full name of the region.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "name": { "description": "The full name of the continent.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/geo-codes.yaml" } } } }, "description": "Successful response." } }, "summary": "List supported geo codes", "tags": [ "Collections" ] }, "x-akamai": { "file-path": "paths/supported-geo-codes.yaml", "path-info": "/collections/supported-geo-codes" } }, "/data/recordset-types": { "get": { "description": "Returns the DNS record types supported for GTM properties, optionally filtered by domain.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-recordset-types" }, "operationId": "get-recordset-types", "parameters": [ { "description": "When specified, returns only the record types supported for the given domain name.", "example": "{{domain}}", "in": "query", "name": "domain", "required": false, "schema": { "example": "example.akadns.net", "type": "string" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "types": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ] }, "schema": { "additionalProperties": false, "description": "The set of DNS record types supported for GTM properties.", "properties": { "types": { "description": "The list of supported DNS record type names, such as `A`, `AAAA`, `CNAME`, `MX`.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/dns-record-types.yaml" } } } }, "description": "Successful response." } }, "summary": "List DNS record set types", "tags": [ "Collections" ] }, "x-akamai": { "file-path": "paths/recordset-types.yaml", "path-info": "/data/recordset-types" } }, "/domains": { "post": { "description": "Creates a new GTM domain.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/post-domain" }, "operationId": "post-domain", "parameters": [ { "description": "A unique identifier for the contract. If your GTM client credential has access to more than one contract, you need to specify under which contract to provision the domain. For more information, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "example": "{{contractId}}", "in": "query", "name": "contractId", "schema": { "example": "K-0N7RAK7", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-query.yaml" } }, { "description": "A unique identifier for the group. If your GTM client credential has access to more than one group, you need to specify which group to assign to the domain. For more information, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "example": "{{gid}}", "in": "query", "name": "gid", "schema": { "example": 15166, "type": "integer" }, "x-akamai": { "file-path": "parameters/gid-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "domain-vnd-config-gtm.v1.0+json": { "example": { "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": null, "healthMultiplier": null, "healthThreshold": null, "ipv6": false, "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "origin", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.7" ], "weight": 50 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.63" ], "weight": 50 } ], "type": "weighted-round-robin", "useComputedTargets": false } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.0", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0.yaml" } } }, "domain-vnd-config-gtm.v1.1+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.1", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1.yaml" } } }, "domain-vnd-config-gtm.v1.2+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.2", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.2.yaml" } } }, "domain-vnd-config-gtm.v1.3+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.3", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.3.yaml" } } }, "domain-vnd-config-gtm.v1.4+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.4", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.4.yaml" } } }, "domain-vnd-config-gtm.v1.5+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.5", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5.yaml" } } }, "domain-vnd-config-gtm.v1.6+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.6", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.6.yaml" } } }, "domain-vnd-config-gtm.v1.7+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": null, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": null, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.7", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.7.yaml" } } }, "domain-vnd-config-gtm.v1.8+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": null, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": null, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.8", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.8.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "domain-vnd-config-gtm.v1.0+json": { "example": { "resource": { "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": null, "healthMultiplier": null, "healthThreshold": null, "ipv6": false, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "origin", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.7" ], "weight": 50 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.63" ], "weight": 50 } ], "type": "weighted-round-robin", "useComputedTargets": false } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.0", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.0.yaml" } } }, "domain-vnd-config-gtm.v1.1+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.1", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.1.yaml" } } }, "domain-vnd-config-gtm.v1.2+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.2", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.2.yaml" } } }, "domain-vnd-config-gtm.v1.3+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.3", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.3.yaml" } } }, "domain-vnd-config-gtm.v1.4+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.4", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.4.yaml" } } }, "domain-vnd-config-gtm.v1.5+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.5", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.5.yaml" } } }, "domain-vnd-config-gtm.v1.6+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.6", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.6.yaml" } } }, "domain-vnd-config-gtm.v1.7+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.7", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.7.yaml" } } }, "domain-vnd-config-gtm.v1.8+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.8", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.8.yaml" } } } }, "description": "The domain was created successfully.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create a domain", "tags": [ "Domains" ] }, "get": { "description": "Returns a list of GTM domain summaries under your contract.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-domains" }, "operationId": "get-domains", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "domain-vnd-config-gtm.v1.0+json": { "example": { "items": [ { "acgId": "1-2345", "deleteRequestId": null, "lastModified": "2014-03-03T16:02:45.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" }, { "acgId": "1-2345", "deleteRequestId": null, "lastModified": "2013-11-09T12:04:45.000Z", "links": [ { "href": "/config-gtm/v1/domains/demo.akadns.net", "rel": "self" } ], "name": "demo.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domains summary.", "items": { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-domain-summary-v1.0.yaml" } } }, "domain-vnd-config-gtm.v1.1+json": { "example": { "items": [ { "acgId": "1-2345", "deleteRequestId": null, "lastModified": "2014-03-03T16:02:45.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" }, { "acgId": "1-2345", "deleteRequestId": null, "lastModified": "2013-11-09T12:04:45.000Z", "links": [ { "href": "/config-gtm/v1/domains/demo.akadns.net", "rel": "self" } ], "name": "demo.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domains summary.", "items": { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-domain-summary-v1.1.yaml" } } }, "domain-vnd-config-gtm.v1.2+json": { "example": { "items": [ { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "lastModified": "2014-03-03T16:02:45.000Z", "lastModifiedBy": "tyamada@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" }, { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "lastModified": "2013-11-09T12:04:45.000Z", "lastModifiedBy": "tyamada@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/demo.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "demo.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domains summary.", "items": { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-domain-summary-v1.2.yaml" } } }, "domain-vnd-config-gtm.v1.3+json": { "example": { "items": [ { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "lastModified": "2014-03-03T16:02:45.000Z", "lastModifiedBy": "tyamada@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" }, { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "lastModified": "2013-11-09T12:04:45.000Z", "lastModifiedBy": "tyamada@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/demo.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "demo.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domains summary.", "items": { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-domain-summary-v1.3.yaml" } } }, "domain-vnd-config-gtm.v1.4+json": { "example": { "items": [ { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2014-03-03T16:02:45.000Z", "lastModifiedBy": "hgildong@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" }, { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2013-11-09T12:04:45.000Z", "lastModifiedBy": "szhang@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/demo.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "demo.akadns.net", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA256", "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domains summary.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-domain-summary-v1.4.yaml" } } }, "domain-vnd-config-gtm.v1.5+json": { "example": { "items": [ { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2014-03-03T16:02:45.000Z", "lastModifiedBy": "hgildong@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" }, { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2013-11-09T12:04:45.000Z", "lastModifiedBy": "szhang@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/demo.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "demo.akadns.net", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA256", "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domains summary.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-domain-summary-v1.5.yaml" } } }, "domain-vnd-config-gtm.v1.6+json": { "example": { "items": [ { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2014-03-03T16:02:45.000Z", "lastModifiedBy": "hgildong@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" }, { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2013-11-09T12:04:45.000Z", "lastModifiedBy": "szhang@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/demo.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "demo.akadns.net", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA256", "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domains summary.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-domain-summary-v1.6.yaml" } } }, "domain-vnd-config-gtm.v1.7+json": { "example": { "items": [ { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2014-03-03T16:02:45.000Z", "lastModifiedBy": "hgildong@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" }, { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2013-11-09T12:04:45.000Z", "lastModifiedBy": "szhang@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/demo.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "demo.akadns.net", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA256", "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domains summary.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-domain-summary-v1.7.yaml" } } }, "domain-vnd-config-gtm.v1.8+json": { "example": { "items": [ { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2014-03-03T16:02:45.000Z", "lastModifiedBy": "hgildong@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" }, { "acgId": "1-2345", "activationState": "COMPLETE", "changeId": "1234", "deleteRequestId": null, "id": 1234, "lastModified": "2013-11-09T12:04:45.000Z", "lastModifiedBy": "szhang@akamai.com", "links": [ { "href": "/config-gtm/v1/domains/demo.akadns.net", "rel": "self" } ], "modificationComments": "It was modified to update it", "name": "demo.akadns.net", "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA256", "status": "2014-02-20 22:56 GMT: Current configuration has been propagated to all GTM name servers" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of GTM domain summaries.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-domain-summary-v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "List domains", "tags": [ "Domains" ] }, "x-akamai": { "file-path": "paths/domains.yaml", "path-info": "/domains" } }, "/domains/delete-requests": { "post": { "description": "Submits an asynchronous request to delete one or more GTM domains. Poll the returned `requestId` using the status endpoint to track progress.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/post-domain-delete-requests" }, "operationId": "post-domain-delete-requests", "parameters": [ { "description": "When `true`, forces deletion to proceed even if safety checks detect potential issues. Defaults to `false`.", "example": "{{bypassSafetyChecks}}", "in": "query", "name": "bypassSafetyChecks", "required": false, "schema": { "default": false, "example": false, "type": "boolean" }, "x-akamai": { "file-path": "parameters/bypass-safety-checks-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comment": "Decommissioning example domain", "domains": [ "example.akadns.net" ] }, "schema": { "additionalProperties": false, "description": "A request to asynchronously delete one or more GTM domains.", "properties": { "comment": { "description": "An optional comment describing the reason for deletion.", "example": "{{comment}}", "maxLength": 1000, "nullable": true, "type": "string" }, "domains": { "description": "The list of domain names to delete.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "domains" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-delete-request.yaml" } } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "requestId": "06c65e1e-65f0-44a0-9edd-fc3e50823e5d" }, "schema": { "additionalProperties": false, "description": "The response returned when a bulk domain delete request is submitted.", "properties": { "requestId": { "description": "A unique identifier for the delete request. Use this to poll the request status or retrieve results.", "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-delete-submit-response.yaml" } } } }, "description": "The delete request was accepted and is being processed." } }, "summary": "Submit a bulk domain delete request", "tags": [ "Domains" ] }, "x-akamai": { "file-path": "paths/domain-delete-requests.yaml", "path-info": "/domains/delete-requests" } }, "/domains/delete-requests/{requestId}": { "get": { "description": "Returns the current status of a bulk domain delete request, including how many domains have been successfully deleted, failed, and whether processing is complete.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-domain-delete-request" }, "operationId": "get-domain-delete-request", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "domainsSubmitted": 1, "expirationDate": "2014-04-10T16:21:27.000Z", "failureCount": 0, "isComplete": false, "requestId": "06c65e1e-65f0-44a0-9edd-fc3e50823e5d", "successCount": 0 }, "schema": { "additionalProperties": false, "description": "The current status of a bulk domain delete request.", "properties": { "domainsSubmitted": { "description": "The total number of domains included in the delete request.", "type": "integer" }, "expirationDate": { "description": "An ISO 8601 timestamp indicating when the delete request record expires and is no longer available.", "format": "date-time", "type": "string" }, "failureCount": { "description": "The number of domains that failed to delete.", "type": "integer" }, "isComplete": { "description": "Whether all domains in the request have been processed. When `true`, you can retrieve the full result.", "type": "boolean" }, "requestId": { "description": "The unique identifier for the delete request.", "minLength": 1, "type": "string" }, "successCount": { "description": "The number of domains successfully deleted so far.", "type": "integer" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-delete-status.yaml" } } } }, "description": "Successful response." } }, "summary": "Get delete request status", "tags": [ "Domains" ] }, "parameters": [ { "description": "A unique identifier for a bulk domain delete request, returned when the request is submitted.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "06c65e1e-65f0-44a0-9edd-fc3e50823e5d", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-delete-request-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/domain-delete-request.yaml", "path-info": "/domains/delete-requests/{requestId}" } }, "/domains/delete-requests/{requestId}/result": { "get": { "description": "Returns the final result of a completed bulk domain delete request, listing which domains were successfully deleted and which failed. Only available once `isComplete` is `true` in the status endpoint.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-domain-delete-request-result" }, "operationId": "get-domain-delete-request-result", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "failedDomains": [], "requestId": "06c65e1e-65f0-44a0-9edd-fc3e50823e5d", "successfullyDeletedDomains": [ "example.akadns.net" ] }, "schema": { "additionalProperties": false, "description": "The result of a completed bulk domain delete request.", "properties": { "failedDomains": { "description": "The list of domains that could not be deleted, with reasons.", "items": { "additionalProperties": false, "properties": { "domain": { "description": "The domain name that failed to delete.", "minLength": 1, "type": "string" }, "failureMessage": { "description": "A human-readable description of the failure reason.", "nullable": true, "type": "string" }, "failureReason": { "description": "A code indicating why deletion failed.", "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "requestId": { "description": "The unique identifier for the delete request.", "minLength": 1, "type": "string" }, "successfullyDeletedDomains": { "description": "The list of domain names that were successfully deleted.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-delete-result.yaml" } } } }, "description": "Successful response." } }, "summary": "Get delete request result", "tags": [ "Domains" ] }, "parameters": [ { "description": "A unique identifier for a bulk domain delete request, returned when the request is submitted.", "example": "{{requestId}}", "in": "path", "name": "requestId", "required": true, "schema": { "example": "06c65e1e-65f0-44a0-9edd-fc3e50823e5d", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-delete-request-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/domain-delete-request-result.yaml", "path-info": "/domains/delete-requests/{requestId}/result" } }, "/domains/{domainName}": { "get": { "description": "Returns information for a specific GTM domain.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-domain" }, "operationId": "get-domain", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "domain-vnd-config-gtm.v1.0+json": { "example": { "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": null, "healthMultiplier": null, "healthThreshold": null, "ipv6": false, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "origin", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.7" ], "weight": 50 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.63" ], "weight": 50 } ], "type": "weighted-round-robin", "useComputedTargets": false } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.0", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0.yaml" } } }, "domain-vnd-config-gtm.v1.1+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.1", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1.yaml" } } }, "domain-vnd-config-gtm.v1.2+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.2", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.2.yaml" } } }, "domain-vnd-config-gtm.v1.3+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Downpatrick", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.3", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.3.yaml" } } }, "domain-vnd-config-gtm.v1.4+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Downpatrick", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.4", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.4.yaml" } } }, "domain-vnd-config-gtm.v1.5+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Downpatrick", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.5", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5.yaml" } } }, "domain-vnd-config-gtm.v1.6+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Downpatrick", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.6", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.6.yaml" } } }, "domain-vnd-config-gtm.v1.7+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Downpatrick", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.7", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.7.yaml" } } }, "domain-vnd-config-gtm.v1.8+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Downpatrick", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.8", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a domain", "tags": [ "Domains" ] }, "put": { "description": "Updates a specific GTM domain.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/put-domain" }, "operationId": "put-domain", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "domain-vnd-config-gtm.v1.0+json": { "example": { "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": null, "healthMultiplier": null, "healthThreshold": null, "ipv6": false, "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "origin", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.7" ], "weight": 50 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.63" ], "weight": 50 } ], "type": "weighted-round-robin", "useComputedTargets": false } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.0", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0.yaml" } } }, "domain-vnd-config-gtm.v1.1+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.1", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1.yaml" } } }, "domain-vnd-config-gtm.v1.2+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.2", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.2.yaml" } } }, "domain-vnd-config-gtm.v1.3+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.3", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.3.yaml" } } }, "domain-vnd-config-gtm.v1.4+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.4", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.4.yaml" } } }, "domain-vnd-config-gtm.v1.5+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.5", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5.yaml" } } }, "domain-vnd-config-gtm.v1.6+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.6", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.6.yaml" } } }, "domain-vnd-config-gtm.v1.7+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": null, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": null, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.7", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.7.yaml" } } }, "domain-vnd-config-gtm.v1.8+json": { "example": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": null, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": null, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.8", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.8.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "domain-vnd-config-gtm.v1.0+json": { "example": { "resource": { "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": null, "healthMultiplier": null, "healthThreshold": null, "ipv6": false, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "origin", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.7" ], "weight": 50 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.63" ], "weight": 50 } ], "type": "weighted-round-robin", "useComputedTargets": false } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.0", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.0.yaml" } } }, "domain-vnd-config-gtm.v1.1+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.1", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.1.yaml" } } }, "domain-vnd-config-gtm.v1.2+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/123", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.2", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.2.yaml" } } }, "domain-vnd-config-gtm.v1.3+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.3", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.3.yaml" } } }, "domain-vnd-config-gtm.v1.4+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.4", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.4.yaml" } } }, "domain-vnd-config-gtm.v1.5+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.5", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.5.yaml" } } }, "domain-vnd-config-gtm.v1.6+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.6", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.6.yaml" } } }, "domain-vnd-config-gtm.v1.7+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.7", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.7.yaml" } } }, "domain-vnd-config-gtm.v1.8+json": { "example": { "resource": { "asMaps": [ { "assignments": [ { "asNumbers": [ 1234, 5678 ], "datacenterId": 1234, "nickname": "myAsMapYeaNickname" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/myAsMapYea", "rel": "self" } ], "name": "myAsMapYea" } ], "cidrMaps": [ { "assignments": [ { "blocks": [ "192.0.2.206", "192.0.2.219/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.155/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ], "cnameCoalescingEnabled": false, "datacenters": [ { "city": "Doune", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true } ], "defaultErrorPenalty": 75, "defaultSslClientCertificate": null, "defaultSslClientPrivateKey": null, "defaultTimeoutPenalty": 25, "deleteRequestId": null, "emailNotificationList": [ "steve@akamai.com", "bob@akamai.com" ], "geographicMaps": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ], "lastModified": "2014-04-08T18:25:51.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "loadFeedback": true, "loadImbalancePercentage": 10, "modificationComments": "CIDRMap example", "name": "example.akadns.net", "properties": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ], "resources": [ { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "CPU utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/cpu", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "cpu", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.77" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cpu", "loadObjectPort": 80, "loadServers": [ "192.0.2.229" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.250" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.80" ], "useDefaultLoadObject": false }, { "datacenterId": 5400, "loadObject": null, "loadObjectPort": 0, "loadServers": [], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ], "signAndServe": true, "signAndServeAlgorithm": "RSA_SHA512", "type": "full" }, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "cidrMaps": { "description": "The set of CIDR maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" }, "defaultErrorPenalty": { "default": 75, "description": "Specifies the download penalty score. If the download encounters an error, the web agent computes a score that's either the download time in seconds or a penalty score. The default penalty is `75`.", "type": "integer" }, "defaultSslClientCertificate": { "description": "Specifies an optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). When the liveness test doesn't contain `sslClientCertificate` and `sslClientPrivateKey` values, use this and the `defaultSslClientPrivateKey` object fields to generate a certificate. In this case, use a separate, throwaway private key when generating a certificate or certificate signing request (CSR). You shouldn't use this key for any other purpose. See also `defaultSslClientPrivateKey` within this object.", "nullable": true, "type": "string" }, "defaultSslClientPrivateKey": { "description": "Specifies an optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests (HTTPS, SMTPS, POPS, and TCPS). See also `defaultSslClientCertificate` within this object.", "nullable": true, "type": "string" }, "defaultTimeoutPenalty": { "default": 25, "description": "Specifies the timeout penalty score. The web agent then computes a score that's either the download time in seconds or a penalty score if the download request times out. The default penalty for a time out is `25`.", "type": "integer" }, "deleteRequestId": { "description": "Unique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.", "nullable": true, "type": "string" }, "emailNotificationList": { "description": "Email addresses to notify when a change is made to the domain.", "items": { "format": "email", "type": "string" }, "type": "array" }, "geographicMaps": { "description": "The set of geographic maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "lastModifiedBy": { "description": "__Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadFeedback": { "description": "Indicates whether you're using `resources` to control load balancing. Resources represent a constraint on how much load a data center can absorb. The value is `true` if you're using load feedback.", "type": "boolean" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "modificationComments": { "description": "A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "resources": { "description": "The resources in the GTM domain.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } }, "type": { "description": "Indicates the type of domain available based on your contract. Possible values are: `failover-only`, `static`, `weighted`, `basic`, or `full`.", "enum": [ "failover-only", "static", "weighted", "basic", "full" ], "type": "string" } }, "required": [ "cidrMaps", "defaultErrorPenalty", "defaultSslClientCertificate", "defaultSslClientPrivateKey", "defaultTimeoutPenalty", "emailNotificationList", "geographicMaps", "lastModified", "lastModifiedBy", "loadFeedback", "loadImbalancePercentage", "modificationComments", "name", "resources", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.0-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "asMaps": { "description": "__v1.1__ The set of AS maps assigned to this domain.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array", "x-akamai": { "labels": [ "v1.1" ] } }, "cnameCoalescingEnabled": { "default": false, "description": "__v1.1__ If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.1" ] } } }, "required": [ "asMaps", "cnameCoalescingEnabled" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.1-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "signAndServe": { "default": false, "description": "__v1.5__ Whether DNSSEC Sign&Serve is enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.5" ] } }, "signAndServeAlgorithm": { "description": "__v1.5__ The algorithm currently or last used for DNSSEC Sign&Serve. `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "required": [ "signAndServe" ], "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.5-base.yaml" } }, { "additionalProperties": true, "description": "The basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as `example.akadns.net`.", "properties": { "datacenters": { "description": "The set of data centers assigned to this domain.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "type": "array" }, "properties": { "description": "The properties in the GTM domain.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "required": [ "datacenters", "properties" ], "type": "object" } ], "title": "Domain v1.8", "x-akamai": { "file-path": "schemas/domain-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-domain-response-v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "Update a domain", "tags": [ "Domains" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/domain.yaml", "path-info": "/domains/{domainName}" } }, "/domains/{domainName}/as-maps": { "get": { "description": "Returns a list of AS maps.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-as-maps" }, "operationId": "get-as-maps", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "assignments": [ { "asNumbers": [ 12222, 16702, 17334 ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "asNumbers": [ 16625 ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other AS numbers" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/The%20North", "rel": "self" } ], "name": "The North" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's autonomous system maps.", "items": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-as-maps.yaml" } } } }, "description": "Successful response." } }, "summary": "List AS maps", "tags": [ "AS maps" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/as-maps.yaml", "path-info": "/domains/{domainName}/as-maps" } }, "/domains/{domainName}/as-maps/{mapName}": { "get": { "description": "Returns information for a specific AS map.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-as-map" }, "operationId": "get-as-map", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "assignments": [ { "asNumbers": [ 12222, 16702, 17334 ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "asNumbers": [ 16625 ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other AS numbers" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/The%20North", "rel": "self" } ], "name": "The North" }, "schema": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } } } }, "description": "Successful response." } }, "summary": "Get an AS map", "tags": [ "AS maps" ] }, "put": { "description": "Run this operation to create or update an AS map.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/put-as-map" }, "operationId": "put-as-map", "parameters": [ { "description": "Specifies change descriptions for audit trail and domain's change history. The maximum is 4000 characters.", "example": "{{domainModificationComments}}", "in": "query", "name": "domainModificationComments", "schema": { "example": "Load balancer policy change", "maxLength": 4000, "nullable": true, "type": "string" }, "x-akamai": { "file-path": "parameters/domain-modification-comments-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "assignments": [ { "asNumbers": [ 12222, 16702, 17334 ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "asNumbers": [ 16625 ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other AS numbers" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/as-maps/The%20North", "rel": "self" } ], "name": "The North" }, "schema": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "example": "{{name}}", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "resource": { "assignments": [ { "asNumbers": [ 16625 ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "asNumbers": [ 12222, 16702, 17334 ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other AS Numbers" }, "name": "The North" }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-as-map-response.yaml" } } } }, "description": "The AS map was updated successfully." }, "201": { "content": { "application/json": { "example": { "resource": { "assignments": [ { "asNumbers": [ 16625 ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "asNumbers": [ 12222, 16702, 17334 ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other AS Numbers" }, "name": "The North" }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "additionalProperties": false, "description": "The AS map configured for the property.", "properties": { "assignments": { "description": "The AS zone groupings of AS IDs.", "items": { "additionalProperties": false, "properties": { "asNumbers": { "description": "Specifies an array of AS numbers.", "items": { "maximum": 4294967295, "minimum": 1, "type": "integer" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "asNumbers", "datacenterId", "nickname" ], "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "datacenterId", "nickname" ], "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the AS map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.", "maxLength": 128, "minLength": 1, "type": "string" } }, "required": [ "assignments", "defaultDatacenter", "name" ], "type": "object", "x-akamai": { "file-path": "schemas/as-map.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-as-map-response.yaml" } } } }, "description": "The AS map was created successfully.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create or update an AS map", "tags": [ "AS maps" ] }, "delete": { "description": "Removes a specific AS map.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/delete-as-map" }, "operationId": "delete-as-map", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "resource": null, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "description": "Reflects the data you just deleted.", "nullable": true, "type": "string" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/delete-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Remove an AS map", "tags": [ "AS maps" ] }, "parameters": [ { "description": "Unique name for the geographic map.", "example": "{{mapName}}", "in": "path", "name": "mapName", "required": true, "schema": { "example": "Software-rollout", "type": "string" }, "x-akamai": { "file-path": "parameters/map-name-path.yaml" } }, { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/as-map.yaml", "path-info": "/domains/{domainName}/as-maps/{mapName}" } }, "/domains/{domainName}/authorities": { "get": { "description": "Returns authorities for a specific GTM domain if it is a custom domain and not hosted on config-gtm.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-domain-authorities" }, "operationId": "get-domain-authorities", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "domain-vnd-config-gtm.v1.0+json": { "example": { "authorities": [ "n3-a1-247.aka-ns.net.", "n3-a12-64.aka-ns.net.", "n3-a13-65.aka-ns.net.", "n3-a18-66.aka-ns.net.", "n3-a20-67.aka-ns.net.", "n3-a7-64.aka-ns.net." ], "contractId": "C-0N7RAC7", "domainName": "tm.aka700.net", "status": "DOMAIN_HAS_AUTHORITIES", "ttlSeconds": 86400 }, "schema": { "additionalProperties": false, "description": "The set of authoritative servers associated with a custom domain.", "properties": { "authorities": { "description": "Authoritative server hostnames that provide DNS responses for the specified domain.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "contractId": { "description": "The contract for this domain.", "type": "string" }, "domainName": { "description": "The domain name for which authorities are defined.", "type": "string" }, "status": { "description": "The status of authorities for the domain, either `DOMAIN_HAS_AUTHORITIES` or `NO_AUTHORITIES`.", "enum": [ "DOMAIN_HAS_AUTHORITIES", "NO_AUTHORITIES" ], "type": "string" }, "ttlSeconds": { "default": 86400, "description": "The recommended time-to-live (TTL), in seconds, for DNS records returned by the authoritative servers.", "type": "integer" } }, "required": [ "domainName", "authorities", "ttlSeconds", "contractId", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-authorities-vnd-config-gtm.yaml" } } }, "domain-vnd-config-gtm.v1.1+json": { "example": { "authorities": [ "n3-a1-247.aka-ns.net.", "n3-a12-64.aka-ns.net.", "n3-a13-65.aka-ns.net.", "n3-a18-66.aka-ns.net.", "n3-a20-67.aka-ns.net.", "n3-a7-64.aka-ns.net." ], "contractId": "C-0N7RAC7", "domainName": "tm.aka700.net", "status": "DOMAIN_HAS_AUTHORITIES", "ttlSeconds": 86400 }, "schema": { "additionalProperties": false, "description": "The set of authoritative servers associated with a custom domain.", "properties": { "authorities": { "description": "Authoritative server hostnames that provide DNS responses for the specified domain.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "contractId": { "description": "The contract for this domain.", "type": "string" }, "domainName": { "description": "The domain name for which authorities are defined.", "type": "string" }, "status": { "description": "The status of authorities for the domain, either `DOMAIN_HAS_AUTHORITIES` or `NO_AUTHORITIES`.", "enum": [ "DOMAIN_HAS_AUTHORITIES", "NO_AUTHORITIES" ], "type": "string" }, "ttlSeconds": { "default": 86400, "description": "The recommended time-to-live (TTL), in seconds, for DNS records returned by the authoritative servers.", "type": "integer" } }, "required": [ "domainName", "authorities", "ttlSeconds", "contractId", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-authorities-vnd-config-gtm.yaml" } } }, "domain-vnd-config-gtm.v1.2+json": { "example": { "authorities": [ "n3-a1-247.aka-ns.net.", "n3-a12-64.aka-ns.net.", "n3-a13-65.aka-ns.net.", "n3-a18-66.aka-ns.net.", "n3-a20-67.aka-ns.net.", "n3-a7-64.aka-ns.net." ], "contractId": "C-0N7RAC7", "domainName": "tm.aka700.net", "status": "DOMAIN_HAS_AUTHORITIES", "ttlSeconds": 86400 }, "schema": { "additionalProperties": false, "description": "The set of authoritative servers associated with a custom domain.", "properties": { "authorities": { "description": "Authoritative server hostnames that provide DNS responses for the specified domain.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "contractId": { "description": "The contract for this domain.", "type": "string" }, "domainName": { "description": "The domain name for which authorities are defined.", "type": "string" }, "status": { "description": "The status of authorities for the domain, either `DOMAIN_HAS_AUTHORITIES` or `NO_AUTHORITIES`.", "enum": [ "DOMAIN_HAS_AUTHORITIES", "NO_AUTHORITIES" ], "type": "string" }, "ttlSeconds": { "default": 86400, "description": "The recommended time-to-live (TTL), in seconds, for DNS records returned by the authoritative servers.", "type": "integer" } }, "required": [ "domainName", "authorities", "ttlSeconds", "contractId", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-authorities-vnd-config-gtm.yaml" } } }, "domain-vnd-config-gtm.v1.3+json": { "example": { "authorities": [ "n3-a1-247.aka-ns.net.", "n3-a12-64.aka-ns.net.", "n3-a13-65.aka-ns.net.", "n3-a18-66.aka-ns.net.", "n3-a20-67.aka-ns.net.", "n3-a7-64.aka-ns.net." ], "contractId": "C-0N7RAC7", "domainName": "tm.aka700.net", "status": "DOMAIN_HAS_AUTHORITIES", "ttlSeconds": 86400 }, "schema": { "additionalProperties": false, "description": "The set of authoritative servers associated with a custom domain.", "properties": { "authorities": { "description": "Authoritative server hostnames that provide DNS responses for the specified domain.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "contractId": { "description": "The contract for this domain.", "type": "string" }, "domainName": { "description": "The domain name for which authorities are defined.", "type": "string" }, "status": { "description": "The status of authorities for the domain, either `DOMAIN_HAS_AUTHORITIES` or `NO_AUTHORITIES`.", "enum": [ "DOMAIN_HAS_AUTHORITIES", "NO_AUTHORITIES" ], "type": "string" }, "ttlSeconds": { "default": 86400, "description": "The recommended time-to-live (TTL), in seconds, for DNS records returned by the authoritative servers.", "type": "integer" } }, "required": [ "domainName", "authorities", "ttlSeconds", "contractId", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-authorities-vnd-config-gtm.yaml" } } }, "domain-vnd-config-gtm.v1.4+json": { "example": { "authorities": [ "n3-a1-247.aka-ns.net.", "n3-a12-64.aka-ns.net.", "n3-a13-65.aka-ns.net.", "n3-a18-66.aka-ns.net.", "n3-a20-67.aka-ns.net.", "n3-a7-64.aka-ns.net." ], "contractId": "C-0N7RAC7", "domainName": "tm.aka700.net", "status": "DOMAIN_HAS_AUTHORITIES", "ttlSeconds": 86400 }, "schema": { "additionalProperties": false, "description": "The set of authoritative servers associated with a custom domain.", "properties": { "authorities": { "description": "Authoritative server hostnames that provide DNS responses for the specified domain.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "contractId": { "description": "The contract for this domain.", "type": "string" }, "domainName": { "description": "The domain name for which authorities are defined.", "type": "string" }, "status": { "description": "The status of authorities for the domain, either `DOMAIN_HAS_AUTHORITIES` or `NO_AUTHORITIES`.", "enum": [ "DOMAIN_HAS_AUTHORITIES", "NO_AUTHORITIES" ], "type": "string" }, "ttlSeconds": { "default": 86400, "description": "The recommended time-to-live (TTL), in seconds, for DNS records returned by the authoritative servers.", "type": "integer" } }, "required": [ "domainName", "authorities", "ttlSeconds", "contractId", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-authorities-vnd-config-gtm.yaml" } } }, "domain-vnd-config-gtm.v1.5+json": { "example": { "authorities": [ "n3-a1-247.aka-ns.net.", "n3-a12-64.aka-ns.net.", "n3-a13-65.aka-ns.net.", "n3-a18-66.aka-ns.net.", "n3-a20-67.aka-ns.net.", "n3-a7-64.aka-ns.net." ], "contractId": "C-0N7RAC7", "domainName": "tm.aka700.net", "status": "DOMAIN_HAS_AUTHORITIES", "ttlSeconds": 86400 }, "schema": { "additionalProperties": false, "description": "The set of authoritative servers associated with a custom domain.", "properties": { "authorities": { "description": "Authoritative server hostnames that provide DNS responses for the specified domain.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "contractId": { "description": "The contract for this domain.", "type": "string" }, "domainName": { "description": "The domain name for which authorities are defined.", "type": "string" }, "status": { "description": "The status of authorities for the domain, either `DOMAIN_HAS_AUTHORITIES` or `NO_AUTHORITIES`.", "enum": [ "DOMAIN_HAS_AUTHORITIES", "NO_AUTHORITIES" ], "type": "string" }, "ttlSeconds": { "default": 86400, "description": "The recommended time-to-live (TTL), in seconds, for DNS records returned by the authoritative servers.", "type": "integer" } }, "required": [ "domainName", "authorities", "ttlSeconds", "contractId", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-authorities-vnd-config-gtm.yaml" } } }, "domain-vnd-config-gtm.v1.6+json": { "example": { "authorities": [ "n3-a1-247.aka-ns.net.", "n3-a12-64.aka-ns.net.", "n3-a13-65.aka-ns.net.", "n3-a18-66.aka-ns.net.", "n3-a20-67.aka-ns.net.", "n3-a7-64.aka-ns.net." ], "contractId": "C-0N7RAC7", "domainName": "tm.aka700.net", "status": "DOMAIN_HAS_AUTHORITIES", "ttlSeconds": 86400 }, "schema": { "additionalProperties": false, "description": "The set of authoritative servers associated with a custom domain.", "properties": { "authorities": { "description": "Authoritative server hostnames that provide DNS responses for the specified domain.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "contractId": { "description": "The contract for this domain.", "type": "string" }, "domainName": { "description": "The domain name for which authorities are defined.", "type": "string" }, "status": { "description": "The status of authorities for the domain, either `DOMAIN_HAS_AUTHORITIES` or `NO_AUTHORITIES`.", "enum": [ "DOMAIN_HAS_AUTHORITIES", "NO_AUTHORITIES" ], "type": "string" }, "ttlSeconds": { "default": 86400, "description": "The recommended time-to-live (TTL), in seconds, for DNS records returned by the authoritative servers.", "type": "integer" } }, "required": [ "domainName", "authorities", "ttlSeconds", "contractId", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-authorities-vnd-config-gtm.yaml" } } }, "domain-vnd-config-gtm.v1.7+json": { "example": { "authorities": [ "n3-a1-247.aka-ns.net.", "n3-a12-64.aka-ns.net.", "n3-a13-65.aka-ns.net.", "n3-a18-66.aka-ns.net.", "n3-a20-67.aka-ns.net.", "n3-a7-64.aka-ns.net." ], "contractId": "C-0N7RAC7", "domainName": "tm.aka700.net", "status": "DOMAIN_HAS_AUTHORITIES", "ttlSeconds": 86400 }, "schema": { "additionalProperties": false, "description": "The set of authoritative servers associated with a custom domain.", "properties": { "authorities": { "description": "Authoritative server hostnames that provide DNS responses for the specified domain.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "contractId": { "description": "The contract for this domain.", "type": "string" }, "domainName": { "description": "The domain name for which authorities are defined.", "type": "string" }, "status": { "description": "The status of authorities for the domain, either `DOMAIN_HAS_AUTHORITIES` or `NO_AUTHORITIES`.", "enum": [ "DOMAIN_HAS_AUTHORITIES", "NO_AUTHORITIES" ], "type": "string" }, "ttlSeconds": { "default": 86400, "description": "The recommended time-to-live (TTL), in seconds, for DNS records returned by the authoritative servers.", "type": "integer" } }, "required": [ "domainName", "authorities", "ttlSeconds", "contractId", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-authorities-vnd-config-gtm.yaml" } } }, "domain-vnd-config-gtm.v1.8+json": { "example": { "authorities": [ "n3-a1-247.aka-ns.net.", "n3-a12-64.aka-ns.net.", "n3-a13-65.aka-ns.net.", "n3-a18-66.aka-ns.net.", "n3-a20-67.aka-ns.net.", "n3-a7-64.aka-ns.net." ], "contractId": "C-0N7RAC7", "domainName": "tm.aka700.net", "status": "DOMAIN_HAS_AUTHORITIES", "ttlSeconds": 86400 }, "schema": { "additionalProperties": false, "description": "The set of authoritative servers associated with a custom domain.", "properties": { "authorities": { "description": "Authoritative server hostnames that provide DNS responses for the specified domain.", "items": { "type": "string" }, "minItems": 0, "type": "array" }, "contractId": { "description": "The contract for this domain.", "type": "string" }, "domainName": { "description": "The domain name for which authorities are defined.", "type": "string" }, "status": { "description": "The status of authorities for the domain, either `DOMAIN_HAS_AUTHORITIES` or `NO_AUTHORITIES`.", "enum": [ "DOMAIN_HAS_AUTHORITIES", "NO_AUTHORITIES" ], "type": "string" }, "ttlSeconds": { "default": 86400, "description": "The recommended time-to-live (TTL), in seconds, for DNS records returned by the authoritative servers.", "type": "integer" } }, "required": [ "domainName", "authorities", "ttlSeconds", "contractId", "status" ], "type": "object", "x-akamai": { "file-path": "schemas/domain-authorities-vnd-config-gtm.yaml" } } } }, "description": "Successful response." } }, "summary": "Get domain authorities", "tags": [ "Domains" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/domain-authorities.yaml", "path-info": "/domains/{domainName}/authorities" } }, "/domains/{domainName}/cidr-maps": { "get": { "description": "Returns a list of CIDR maps.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-cidr-maps" }, "operationId": "get-cidr-maps", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "assignments": [ { "blocks": [ "192.0.2.119/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.54/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's CIDR maps.", "items": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-cidr-maps.yaml" } } } }, "description": "Successful response." } }, "summary": "List CIDR maps", "tags": [ "CIDR maps" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/cidr-maps.yaml", "path-info": "/domains/{domainName}/cidr-maps" } }, "/domains/{domainName}/cidr-maps/{mapName}": { "get": { "description": "Returns information for a specific CIDR map.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-cidr-map" }, "operationId": "get-cidr-map", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "assignments": [ { "blocks": [ "192.0.2.135/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.87/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ], "name": "The North" }, "schema": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a CIDR map", "tags": [ "CIDR maps" ] }, "put": { "description": "Run this operation to create or update a CIDR map.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/put-cidr-map" }, "operationId": "put-cidr-map", "parameters": [ { "description": "Specifies change descriptions for audit trail and domain's change history. The maximum is 4000 characters.", "example": "{{domainModificationComments}}", "in": "query", "name": "domainModificationComments", "schema": { "example": "Load balancer policy change", "maxLength": 4000, "nullable": true, "type": "string" }, "x-akamai": { "file-path": "parameters/domain-modification-comments-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "assignments": [ { "blocks": [ "192.0.2.244", "192.0.2.164/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.255/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "name": "The North" }, "schema": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "example": "{{name}}", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "resource": { "assignments": [ { "blocks": [ "192.0.2.73", "192.0.2.91/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.106/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%2520North", "rel": "self" } ], "name": "The North" }, "status": { "changeId": "93a48b86-4fc3-4a5f-9ca2-036835034cc6", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-cidr-map-response.yaml" } } } }, "description": "The CIDR map was updated successfully." }, "201": { "content": { "application/json": { "example": { "resource": { "assignments": [ { "blocks": [ "192.0.2.73", "192.0.2.91/24" ], "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men" }, { "blocks": [ "192.0.2.106/24" ], "datacenterId": 3133, "nickname": "Winterfell" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%2520North", "rel": "self" } ], "name": "The North" }, "status": { "changeId": "93a48b86-4fc3-4a5f-9ca2-036835034cc6", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "additionalProperties": false, "description": "The CIDR map configured for the property.", "properties": { "assignments": { "description": "The CIDR zone groupings of CIDR blocks.", "items": { "additionalProperties": false, "properties": { "blocks": { "description": "Specifies an array of CIDR blocks.", "items": { "maxLength": 256, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the CIDR zone group, up to 256 characters.", "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the CIDR map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the CIDR map, up to 255 characters.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/cidr-dto.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-cidr-map-response.yaml" } } } }, "description": "The CIDR map was created successfully.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create or update a CIDR map", "tags": [ "CIDR maps" ] }, "delete": { "description": "Removes a specific CIDR map.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/delete-cidr-map" }, "operationId": "delete-cidr-map", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "resource": null, "status": { "changeId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "description": "Reflects the data you just deleted.", "nullable": true, "type": "string" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/delete-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Remove a CIDR map", "tags": [ "CIDR maps" ] }, "parameters": [ { "description": "Unique name for the geographic map.", "example": "{{mapName}}", "in": "path", "name": "mapName", "required": true, "schema": { "example": "Software-rollout", "type": "string" }, "x-akamai": { "file-path": "parameters/map-name-path.yaml" } }, { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/cidr-map.yaml", "path-info": "/domains/{domainName}/cidr-maps/{mapName}" } }, "/domains/{domainName}/datacenters": { "post": { "description": "This operation creates a specific data center.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/post-datacenter" }, "operationId": "post-datacenter", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" }, "schema": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "city": "Doune", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "city": "Doune", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185096, "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "resource": { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.176", "192.0.2.69" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "resource": { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.176", "192.0.2.69" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "resource": { "city": "Doune", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.176", "192.0.2.69" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire" }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "resource": { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "resource": { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "resource": { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "resource": { "city": "Doune", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "resource": { "city": "Doune", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "resource": { "city": "Doune", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": "/dbload.xml", "loadObjectPort": 80, "loadServers": [ "192.0.2.125", "192.0.2.33" ] }, "latitude": 56.185096, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire" }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.8.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create a data center", "tags": [ "Data centers" ] }, "get": { "description": "This operation returns a list of data centers.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-datacenters" }, "operationId": "get-datacenters", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "items": [ { "city": "Doune", "cloneOf": 0, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185097, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire", "virtual": true }, { "city": "Snaefellsjokull", "cloneOf": 0, "continent": "EU", "country": "IS", "datacenterId": 3134, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 64.808, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ], "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of information about the data centers.", "items": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-datacenters-v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "items": [ { "city": "Doune", "cloneOf": 0, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185097, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire", "virtual": true }, { "city": "Snaefellsjokull", "cloneOf": 0, "continent": "EU", "country": "IS", "datacenterId": 3134, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 64.808, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ], "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of information about the data centers.", "items": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-datacenters-v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "items": [ { "city": "Doune", "cloneOf": 0, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185097, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire", "virtual": true }, { "city": "Snaefellsjokull", "cloneOf": 0, "continent": "EU", "country": "IS", "datacenterId": 3134, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 64.808, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ], "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of information about the data centers.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-datacenters-v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "items": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185097, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true }, { "city": "Snaefellsjokull", "cloneOf": 0, "continent": "EU", "country": "IS", "datacenterId": 3134, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 64.808, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ], "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of information about the data centers.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-datacenters-v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "items": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185097, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true }, { "city": "Snaefellsjokull", "cloneOf": 0, "continent": "EU", "country": "IS", "datacenterId": 3134, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 64.808, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ], "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of information about the data centers.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-datacenters-v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "items": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185097, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true }, { "city": "Snaefellsjokull", "cloneOf": 0, "continent": "EU", "country": "IS", "datacenterId": 3134, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 64.808, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ], "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of information about the data centers.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-datacenters-v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "items": [ { "city": "Doune", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185097, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true }, { "city": "Snaefellsjokull", "cloneOf": 0, "continent": "EU", "country": "IS", "datacenterId": 3134, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 64.808, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ], "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of information about the data centers.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-datacenters-v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "items": [ { "city": "Doune", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185097, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true }, { "city": "Snaefellsjokull", "cloneOf": 0, "cloud": null, "continent": "EU", "country": "IS", "datacenterId": 3134, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 64.808, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ], "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of information about the data centers.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-datacenters-v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "items": [ { "city": "Doune", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 56.185097, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -4.050264, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": "Perthshire", "virtual": true }, { "city": "Snaefellsjokull", "cloneOf": 0, "cloud": null, "continent": "EU", "country": "IS", "datacenterId": 3134, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 64.808, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ], "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's data centers.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-datacenters-v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "List data centers", "tags": [ "Data centers" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/data-centers.yaml", "path-info": "/domains/{domainName}/datacenters" } }, "/domains/{domainName}/datacenters/datacenter-for-ip-version-selector-ipv4": { "post": { "description": "This operation creates a data center which is solely reserved for use by properties of the IP Version Selector type `qtr`. The data center created by this resource is assigned the `datacenterId` 5401, which is interpreted as the target for `A` record requests.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/post-datacenter-for-ipv" }, "operationId": "post-datacenter-for-ipv", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "201": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5401, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5401, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5401, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5401, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5401, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5401, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5401, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloud": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5401, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloud": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5401, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5401", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.8.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create an IPv4 data center for ip-version-selector", "tags": [ "Data centers" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/data-center-ipv4.yaml", "path-info": "/domains/{domainName}/datacenters/datacenter-for-ip-version-selector-ipv4" } }, "/domains/{domainName}/datacenters/datacenter-for-ip-version-selector-ipv6": { "post": { "description": "This operation creates a data center which is solely reserved for use by properties of type `qtr` (IP Version Selector). The data center created by this resource is assigned the `datacenterId` 5402, which is interpreted as the target for `AAAA` record requests.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/post-datacenter-for-ipv6" }, "operationId": "post-datacenter-for-ipv6", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "201": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5402, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5402, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5402, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5402, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5402, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5402, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5402, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloud": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5402, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloud": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5402, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5402", "rel": "self" } ], "longitude": 0, "nickname": "Target for AAAA records", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.8.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create an IPv6 data center for ip-version-selector", "tags": [ "Data centers" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/data-center-ipv6.yaml", "path-info": "/domains/{domainName}/datacenters/datacenter-for-ip-version-selector-ipv6" } }, "/domains/{domainName}/datacenters/default-datacenter-for-maps": { "post": { "description": "This operation creates a data center for use by the map-type properties CIDR, Geographic or AS mapping as the default data center.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/post-default-datacenter-for-maps" }, "operationId": "post-default-datacenter-for-maps", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "201": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5400, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400", "rel": "self" } ], "longitude": 0, "nickname": "Default Datacenter", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5400, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400", "rel": "self" } ], "longitude": 0, "nickname": "Default Datacenter", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5400, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400", "rel": "self" } ], "longitude": 0, "nickname": "Default Datacenter", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5400, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400", "rel": "self" } ], "longitude": 0, "nickname": "Default Datacenter", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5400, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400", "rel": "self" } ], "longitude": 0, "nickname": "Default Datacenter", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5400, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400", "rel": "self" } ], "longitude": 0, "nickname": "Default Datacenter", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5400, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400", "rel": "self" } ], "longitude": 0, "nickname": "Default Datacenter", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloud": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5400, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400", "rel": "self" } ], "longitude": 0, "nickname": "Default Datacenter", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "resource": { "city": null, "cloneOf": null, "cloud": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": null, "country": null, "datacenterId": 5400, "defaultLoadObject": null, "latitude": 0, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/5400", "rel": "self" } ], "longitude": 0, "nickname": "Default Datacenter", "scorePenalty": 0, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "b97e535e-cec7-417c-bb1e-90fc06bf7783", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2020-02-18T22:31:00.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.8.yaml" } } } }, "description": "Successful response.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create a default data center", "tags": [ "Data centers" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/data-center-default.yaml", "path-info": "/domains/{domainName}/datacenters/default-datacenter-for-maps" } }, "/domains/{domainName}/datacenters/{datacenterId}": { "get": { "description": "This operation returns information for a specific data center.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-datacenter" }, "operationId": "get-datacenter", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "city": "Downpatrick", "cloneOf": 0, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "stateOrProvince": null, "virtual": true }, "schema": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "city": "Downpatrick", "cloneOf": 0, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "stateOrProvince": null, "virtual": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "city": "Downpatrick", "cloneOf": 0, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "stateOrProvince": null, "virtual": true }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "city": "Downpatrick", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "city": "Downpatrick", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "city": "Downpatrick", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "city": "Downpatrick", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "city": "Downpatrick", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "city": "Downpatrick", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a data center", "tags": [ "Data centers" ] }, "put": { "description": "This operation updates a specific data center.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/put-datacenter" }, "operationId": "put-datacenter", "parameters": [ { "description": "Specifies change descriptions for audit trail and domain's change history. The maximum is 4000 characters.", "example": "{{domainModificationComments}}", "in": "query", "name": "domainModificationComments", "schema": { "example": "Load balancer policy change", "maxLength": 4000, "nullable": true, "type": "string" }, "x-akamai": { "file-path": "parameters/domain-modification-comments-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "city": "Downpatrick", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell" }, "schema": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "city": "Downpatrick", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell" }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "city": "Downpatrick", "cloneOf": null, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "city": "Downpatrick", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "city": "Downpatrick", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "city": "Downpatrick", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "city": "Downpatrick", "cloneOf": null, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "city": "Downpatrick", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "city": "Downpatrick", "cloneOf": null, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7 }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "stateOrProvince": null, "virtual": true }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "cloud": { "provider": "akamai-cloud", "regionId": "us-east" }, "cloudServerHostHeaderOverride": false, "cloudServerTargeting": false, "continent": "EU", "country": "GB", "datacenterId": 3133, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "latitude": 54.367, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ], "longitude": -5.582, "nickname": "Winterfell", "scorePenalty": 7, "stateOrProvince": null, "virtual": true }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "Update a data center", "tags": [ "Data centers" ] }, "delete": { "description": "Remove a data center: This operation removes a data center. You can only remove a data center when no properties or resources are assigned to it.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/delete-datacenter" }, "operationId": "delete-datacenter", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "datacenter-vnd-config-gtm.v1.0+json": { "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.0.yaml" } } }, "datacenter-vnd-config-gtm.v1.1+json": { "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.1.yaml" } } }, "datacenter-vnd-config-gtm.v1.2+json": { "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.2.yaml" } } }, "datacenter-vnd-config-gtm.v1.3+json": { "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.3.yaml" } } }, "datacenter-vnd-config-gtm.v1.4+json": { "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.4.yaml" } } }, "datacenter-vnd-config-gtm.v1.5+json": { "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.5.yaml" } } }, "datacenter-vnd-config-gtm.v1.6+json": { "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.6.yaml" } } }, "datacenter-vnd-config-gtm.v1.7+json": { "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.7.yaml" } } }, "datacenter-vnd-config-gtm.v1.8+json": { "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "city": { "description": "The name of the city where the data center is located.", "nullable": true, "type": "string" }, "cloneOf": { "description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes `continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude` from the data center of which it's a clone.", "nullable": true, "type": "integer" }, "cloudServerTargeting": { "description": "Whether cloud server targeting is enabled to balance load between two or more servers in a cloud environment.", "type": "boolean" }, "continent": { "description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Possible values are: `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`.", "enum": [ "AF", "AS", "EU", "NA", "OC", "OT", "SA" ], "maxLength": 2, "nullable": true, "type": "string" }, "country": { "description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.", "maxLength": 2, "nullable": true, "type": "string" }, "datacenterId": { "description": "__Read-only__ A unique identifier for an existing data center in the domain.", "readOnly": true, "type": "integer" }, "defaultLoadObject": { "additionalProperties": false, "description": "Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual resources can specify `useDefaultLoadObject` to use it instead of specifying their own.", "properties": { "loadObject": { "description": "Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a `:` character, and is limited to a maximum of 256 characters.", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port to connect to when requesting the load object. A value of `0` means to use the default port, equivalent to either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "maxLength": 256, "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "latitude": { "description": "Specifies the geographical latitude of the data center's position. See also `longitude` within this object.", "type": "number" }, "links": { "description": "A URL path that allows direct navigation to a data center.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "longitude": { "description": "Specifies the geographic longitude of the data center's position. See also `latitude` within this object.", "type": "number" }, "nickname": { "description": "A descriptive label for the data center.", "maxLength": 256, "type": "string" }, "stateOrProvince": { "description": "Specifies a two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code for the state or province where the data center is located.", "nullable": true, "type": "string" }, "virtual": { "description": "__Read-only__ Whether the data center is virtual. `true` when no cloud provider or physical region is associated with the data center. `false` when a cloud provider or physical region is set.", "readOnly": true, "type": "boolean" } }, "type": "object", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.0.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.1", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.1.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.2", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloudServerHostHeaderOverride": { "description": "__v1.3__ Whether the host header sent during liveness tests is overridden with the cloud server's host name. Requires `cloudServerTargeting` to be enabled.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "scorePenalty": { "description": "__v1.3__ Influences the score for a data center. Giving a positive penalty increases the score and drives traffic away from the data center. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that `scorePenalty` applies only for properties that use performance load balancing.", "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } } }, "type": "object" } ], "title": "datacenter v1.3", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.3.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.4", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.4.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.5", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.5.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.6", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.6.yaml" } }, { "additionalProperties": true, "description": "The data centers in the GTM domain.", "properties": { "cloud": { "additionalProperties": false, "description": "__v1.7__ Identifies the cloud provider and region for this data center.", "nullable": true, "properties": { "provider": { "description": "The cloud provider for this data center.", "type": "string" }, "regionId": { "description": "The cloud region identifier for this data center.", "type": "string" } }, "type": "object", "x-akamai": { "labels": [ "v1.7" ] } } }, "type": "object" } ], "title": "datacenter v1.7", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.7.yaml" } }, { "description": "The data centers in the GTM domain.", "type": "object" } ], "title": "datacenter v1.8", "x-akamai": { "file-path": "schemas/datacenter-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-datacenter-response-v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "Remove a data center", "tags": [ "Data centers" ] }, "parameters": [ { "description": "Numeric `id` of the data center.", "example": "{{datacenterId}}", "in": "path", "name": "datacenterId", "required": true, "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/datacenter-id-path.yaml" } }, { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/data-center.yaml", "path-info": "/domains/{domainName}/datacenters/{datacenterId}" } }, "/domains/{domainName}/features": { "get": { "description": "Returns the contract features available for a specific GTM domain, including the set of supported property types and security features such as DNSSEC.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-domain-features" }, "operationId": "get-domain-features", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "contractId": "K-0N7RAK7", "features": [ "FAILOVER", "PERFORMANCE", "WEIGHTED_ROUND_ROBIN", "GEOGRAPHIC", "CIDRMAPPING", "ASMAPPING" ], "permissions": [ "CREATE", "DELETE", "READ", "WRITE" ], "securityFeatures": [] }, "schema": { "additionalProperties": false, "description": "Contract features available for a domain.", "properties": { "contractId": { "description": "The contract ID associated with the domain.", "type": "string" }, "features": { "description": "The set of property types available under this contract.", "items": { "type": "string" }, "type": "array" }, "permissions": { "description": "The set of permissions granted under this contract.", "items": { "type": "string" }, "type": "array" }, "securityFeatures": { "description": "The set of security features available under this contract, such as `DNSSEC_SIGN_AND_SERVE`.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-features.yaml" } } } }, "description": "Successful response." } }, "summary": "Get domain features", "tags": [ "Domains" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/domain-features.yaml", "path-info": "/domains/{domainName}/features" } }, "/domains/{domainName}/geographic-maps": { "get": { "description": "Returns a list of geographic maps.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-geographic-maps" }, "operationId": "get-geographic-maps", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's geographic maps.", "items": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-geo-maps.yaml" } } } }, "description": "Successful response." } }, "summary": "List geographic maps", "tags": [ "Geographic maps" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/geographic-maps.yaml", "path-info": "/domains/{domainName}/geographic-maps" } }, "/domains/{domainName}/geographic-maps/{mapName}": { "get": { "description": "Returns information for a specific geographic map.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-geographic-map" }, "operationId": "get-geographic-map", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" }, "schema": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a geographic map", "tags": [ "Geographic maps" ] }, "put": { "description": "Run this operation to create or update a geographic map.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/put-geographic-map" }, "operationId": "put-geographic-map", "parameters": [ { "description": "Specifies change descriptions for audit trail and domain's change history. The maximum is 4000 characters.", "example": "{{domainModificationComments}}", "in": "query", "name": "domainModificationComments", "schema": { "example": "Load balancer policy change", "maxLength": 4000, "nullable": true, "type": "string" }, "x-akamai": { "file-path": "parameters/domain-modification-comments-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "name": "UK Delivery" }, "schema": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "example": "{{name}}", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "resource": { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" }, "status": { "changeId": "f2977f97-565b-46af-abfb-1da7e3e8c54b", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-geographic-map-response.yaml" } } } }, "description": "The geographic map was updated successfully." }, "201": { "content": { "application/json": { "example": { "resource": { "assignments": [ { "countries": [ "GB" ], "datacenterId": 3133, "nickname": "UK users" } ], "defaultDatacenter": { "datacenterId": 5400, "nickname": "Default Mapping" }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/geographic-maps/UK%20Delivery", "rel": "self" } ], "name": "UK Delivery" }, "status": { "changeId": "f2977f97-565b-46af-abfb-1da7e3e8c54b", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "additionalProperties": false, "description": "The geographic map configured for the property.", "properties": { "assignments": { "description": "The geographic zone groupings of countries.", "items": { "additionalProperties": false, "properties": { "countries": { "description": "Specifies an array of two-letter ISO 3166 `country` codes, or for finer subdivisions, the two-letter `country` code and the two-letter `stateOrProvince` code separated by a forward slash. For example, `US/TX`.", "items": { "maxLength": 10, "minLength": 1, "type": "string" }, "type": "array" }, "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "nickname": { "description": "A descriptive label for the group.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "type": "array" }, "defaultDatacenter": { "additionalProperties": false, "description": "A placeholder for all other geographic zones, countries not found in these geographic zones. Note that a geographic map cannot have the same countries in multiple geographic zones.", "properties": { "datacenterId": { "description": "For each property, an identifier for all other geographic zones' CNAME. For example, 5400.", "type": "integer" }, "nickname": { "description": "A descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to `Default Mapping`.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object" }, "links": { "description": "Specifies the URL path that allows direct navigation to the geographic map.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "A descriptive label for the geographic map, up to 128 characters.", "maxLength": 128, "minLength": 1, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/geographic-map.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-geographic-map-response.yaml" } } } }, "description": "The geographic map was created successfully.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create or update a geographic map", "tags": [ "Geographic maps" ] }, "delete": { "description": "Removes a geographic map.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/delete-geographic-map" }, "operationId": "delete-geographic-map", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "resource": null, "status": { "changeId": "a97bedfe-c997-4634-84a4-cdb31529fb4c", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T13:44:53.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "description": "Reflects the data you just deleted.", "nullable": true, "type": "string" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/delete-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Remove a geographic map", "tags": [ "Geographic maps" ] }, "parameters": [ { "description": "Unique name for the geographic map.", "example": "{{mapName}}", "in": "path", "name": "mapName", "required": true, "schema": { "example": "Software-rollout", "type": "string" }, "x-akamai": { "file-path": "parameters/map-name-path.yaml" } }, { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/geographic-map.yaml", "path-info": "/domains/{domainName}/geographic-maps/{mapName}" } }, "/domains/{domainName}/history": { "get": { "description": "Returns a list of each change made to the domain.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-domain-history" }, "operationId": "get-domain-history", "parameters": [ { "description": "The page number to return. The first is page 1.", "example": "{{page}}", "in": "query", "name": "page", "schema": { "example": 1, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, { "description": "The number of elements to return per page. The default is 25.", "example": "{{pageSize}}", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 20, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-size-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "changes": [ { "changes": [ "lastModifiedTime changed: \"2021-02-11 13:50:22 +0000\" => \"2021-02-11 15:50:57 +0000\"\nlastModifiedBy changed: \"tier2@example.net\" => \"admin@example.net\"\nmodificationComments changed to: \"Add chicago back into rotation\"\nProperty \"www\" changed:\n Instance of Property \"www\", target \"Chicago\" (region 3131) changed:\n Server \"1.2.3.4\" deleted\n Server \"5.6.7.8\" added" ], "comments": "Add chicago back into rotation", "domain": "example.akadns.net", "domainVersionId": "d10424df-8bca-457d-8f0f-de801d67a598", "modificationDate": "2021-02-11T15:50:57Z", "modifiedBy": "admin@example.net", "modifiedByClientId": "4321", "modifiedByClientName": "happy.akamai.com" }, { "changes": [ "lastModifiedTime changed: \"2021-02-11 11:20:22 +0000\" => \"2021-02-11 13:50:22 +0000\"\nmodificationComments changed to: \"Bumping test frequency.\"\nProperty \"www\" changed:\n Liveness test \"health\" changed:\n testInterval changed: 86400 => 60" ], "comments": "Bumping test frequency.", "domain": "example.akadns.net", "domainVersionId": "60662aca-b36c-11eb-8529-0242ac130003", "modificationDate": "2021-02-11T13:50:22Z", "modifiedBy": "jkowalski@example.net", "modifiedByClientId": "4321", "modifiedByClientName": "happy.akamai.com" }, { "changes": [ "lastModifiedTime changed: \"2021-02-03 09:45:00 +0000\" => \"2021-02-11 11:20:22 +0000\"\nmodificationComments changed to: \"Increase TTL.\"\nProperty \"www\" changed:\n dynamicTTL changed: 301 => 600" ], "comments": "Increase TTL.", "domain": "example.akadns.net", "domainVersionId": "6703bc94-b36c-11eb-8529-0242ac130003", "modificationDate": "2021-02-11T11:20:22Z", "modifiedBy": "afero@example.net", "modifiedByClientId": "4321", "modifiedByClientName": "happy.akamai.com" }, { "changes": [ "lastModifiedTime changed: \"2021-02-03 08:00:00 +0000\" => \"2021-02-03 09:45:00 +0000\"\nmodificationComments changed to: \"Decrease TTL.\"\nProperty \"www\" changed:\n dynamicTTL changed: 3600 => 301" ], "comments": "Decrease TTL.", "domain": "example.akadns.net", "domainVersionId": "6ba17d40-b36c-11eb-8529-0242ac130003", "modificationDate": "2021-02-03T09:45:00Z", "modifiedBy": "mrossi@example.net", "modifiedByClientId": "4321", "modifiedByClientName": "happy.akamai.com" } ], "links": [ { "href": "https://akab.luna.akamaiapis.net/config-gtm/v1/domains/example.akadns.net/history/?page=1&pageSize=25", "rel": "self" } ], "metadata": { "lastPage": 1, "page": 1, "pageSize": 25, "totalElements": 4, "uri": "https://akab.luna.akamaiapis.net/config-gtm/v1/domains/example.akadns.net/history/?page=1&pageSize=25" } }, "schema": { "additionalProperties": false, "properties": { "changes": { "description": "The list of changes for a domain.", "items": { "additionalProperties": false, "properties": { "changes": { "description": "A textual representation of the changes that were made to the domain.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "comments": { "description": "The modification comments that were given as reason for the change.", "nullable": true, "type": "string" }, "domain": { "description": "The name of the domain.", "type": "string" }, "domainVersionId": { "description": "The domainVersionId that was associated with this change.", "nullable": true, "type": "string" }, "modificationDate": { "description": "An ISO 8601 timestamp indicating when the change was made.", "format": "date-time", "type": "string" }, "modifiedBy": { "description": "The name of the user who made the change.", "type": "string" }, "modifiedByClientId": { "description": "The ID of the Akamai API client that made the change, if applicable.", "nullable": true, "type": "string" }, "modifiedByClientName": { "description": "The name of the Akamai API client that made the change, if applicable.", "nullable": true, "type": "string" } }, "required": [ "domain", "modificationDate", "modifiedBy", "modifiedByClientId", "modifiedByClientName", "comments", "changes", "domainVersionId" ], "type": "object" }, "type": "array" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "metadata": { "additionalProperties": false, "description": "Provides information about the page of data that this response contains.", "properties": { "lastPage": { "description": "The number of the last page which can be fetched.", "type": "integer" }, "page": { "default": 1, "description": "The number of the current page.", "type": "integer" }, "pageSize": { "default": 25, "description": "The number of items per page.", "type": "integer" }, "totalElements": { "description": "The total number of history items available for the domain.", "type": "integer" }, "uri": { "description": "The uri of this response.", "type": "string" } }, "required": [ "lastPage", "pageSize", "page", "uri", "totalElements" ], "type": "object" } }, "required": [ "metadata", "changes", "links" ], "title": "Domain history list", "type": "object", "x-akamai": { "file-path": "schemas/domain-history-response.yaml" } } } }, "description": "Successful response." } }, "summary": "List domain history", "tags": [ "Domains" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/history.yaml", "path-info": "/domains/{domainName}/history" } }, "/domains/{domainName}/properties": { "get": { "description": "Returns a list of GTM properties.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-properties" }, "operationId": "get-properties", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false }, { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": true, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/mail", "rel": "self" } ], "livenessTests": [], "mapName": null, "mxRecords": [], "name": "mail", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "2001:db8:ba9f:b6c2:6db8:d78d:dd39:9025" ], "weight": 1 }, { "datacenterId": 3133, "enabled": true, "servers": [ "2001:db8:b277:be2f:23c0:2fa7:8daa:3a8a", "2001:db8:2f03:7c60:38e2:286e:18ee:9436" ], "weight": 1 } ], "type": "weighted-round-robin", "useComputedTargets": false } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "List properties", "tags": [ "Properties" ] }, "put": { "description": "Replaces the complete set of properties on a domain with those specified in the request body.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/put-properties" }, "operationId": "put-properties", "parameters": [ { "description": "Specifies change descriptions for audit trail and domain's change history. The maximum is 4000 characters.", "example": "{{domainModificationComments}}", "in": "query", "name": "domainModificationComments", "schema": { "example": "Load balancer policy change", "maxLength": 4000, "nullable": true, "type": "string" }, "x-akamai": { "file-path": "parameters/domain-modification-comments-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false }, { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": true, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/mail", "rel": "self" } ], "livenessTests": [], "mapName": null, "mxRecords": [], "name": "mail", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "2001:db8:ba9f:b6c2:6db8:d78d:dd39:9025" ], "weight": 1 }, { "datacenterId": 3133, "enabled": true, "servers": [ "2001:db8:b277:be2f:23c0:2fa7:8daa:3a8a", "2001:db8:2f03:7c60:38e2:286e:18ee:9436" ], "weight": 1 } ], "type": "weighted-round-robin", "useComputedTargets": false } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.8.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.0.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.8.yaml" } } } }, "description": "Properties replaced successfully." } }, "summary": "Replace all properties", "tags": [ "Properties" ] }, "patch": { "description": "Adds or updates properties on a domain without replacing the entire set. Properties not included in the request body are left unchanged.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/patch-properties" }, "operationId": "patch-properties", "parameters": [ { "description": "Specifies change descriptions for audit trail and domain's change history. The maximum is 4000 characters.", "example": "{{domainModificationComments}}", "in": "query", "name": "domainModificationComments", "schema": { "example": "Load balancer policy change", "maxLength": 4000, "nullable": true, "type": "string" }, "x-akamai": { "file-path": "parameters/domain-modification-comments-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false }, { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": true, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/mail", "rel": "self" } ], "livenessTests": [], "mapName": null, "mxRecords": [], "name": "mail", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "2001:db8:ba9f:b6c2:6db8:d78d:dd39:9025" ], "weight": 1 }, { "datacenterId": 3133, "enabled": true, "servers": [ "2001:db8:b277:be2f:23c0:2fa7:8daa:3a8a", "2001:db8:2f03:7c60:38e2:286e:18ee:9436" ], "weight": 1 } ], "type": "weighted-round-robin", "useComputedTargets": false } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "items": [ { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.8.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.0.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "resource": { "items": [ { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "ipv6": false, "lastModified": "2014-04-07T16:21:27.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.98" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.146" ], "weight": 1 } ], "type": "failover", "useComputedTargets": false } ] }, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "additionalProperties": true, "description": "The updated list of properties for the domain.", "properties": { "items": { "description": "The list of a domain's properties.", "items": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-properties-v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The status of the domain change request.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-properties-response-v1.8.yaml" } } } }, "description": "Properties added or updated successfully." } }, "summary": "Add or update properties", "tags": [ "Properties" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/properties.yaml", "path-info": "/domains/{domainName}/properties" } }, "/domains/{domainName}/properties/{propertyName}": { "get": { "description": "Returns information for a specific GTM property.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-property" }, "operationId": "get-property", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "cname": null, "comments": null, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": null, "healthMultiplier": null, "healthThreshold": null, "ipv6": false, "lastModified": "2014-04-08T15:11:10.000Z", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/www", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "loadImbalancePercentage": null, "mapName": null, "maxUnreachablePenalty": null, "mxRecords": [], "name": "www", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "handoutCName": null, "name": null, "servers": [ "192.0.2.181" ], "weight": 0 }, { "datacenterId": 3133, "enabled": true, "handoutCName": null, "name": null, "servers": [ "192.0.2.144" ], "weight": 1 } ], "type": "failover", "unreachableThreshold": null, "useComputedTargets": false }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a property", "tags": [ "Properties" ] }, "put": { "description": "Run this operation to create or update a GTM property.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/put-property" }, "operationId": "put-property", "parameters": [ { "description": "Specifies change descriptions for audit trail and domain's change history. The maximum is 4000 characters.", "example": "{{domainModificationComments}}", "in": "query", "name": "domainModificationComments", "schema": { "example": "Load balancer policy change", "maxLength": 4000, "nullable": true, "type": "string" }, "x-akamai": { "file-path": "parameters/domain-modification-comments-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": null, "healthMultiplier": null, "healthThreshold": null, "ipv6": false, "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "mapName": null, "mxRecords": [], "name": "origin", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "servers": [ "192.0.2.7" ], "weight": 50 }, { "datacenterId": 3133, "enabled": true, "servers": [ "192.0.2.63" ], "weight": 50 } ], "type": "weighted-round-robin", "useComputedTargets": false }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": 0.75, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": { "format": "json-compact", "url": "https://example.com/webhooks/gtm-notifications" }, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "schema": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "resource": { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "cname": null, "comments": null, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": null, "healthMultiplier": null, "healthThreshold": null, "ipv6": false, "lastModified": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "loadImbalancePercentage": null, "mapName": null, "maxUnreachablePenalty": null, "mxRecords": [], "name": "origin", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "handoutCName": null, "name": null, "servers": [ "192.0.2.4" ], "weight": 50 }, { "datacenterId": 3133, "enabled": true, "handoutCName": null, "name": null, "servers": [ "192.0.2.102" ], "weight": 50 } ], "type": "weighted-round-robin", "unreachableThreshold": null, "useComputedTargets": false }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.0.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": null, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": null, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": null, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": null, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.8.yaml" } } } }, "description": "The property was updated successfully." }, "201": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "resource": { "backupCName": null, "backupIp": null, "balanceByDownloadScore": false, "cname": null, "comments": null, "dynamicTTL": 300, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": null, "healthMultiplier": null, "healthThreshold": null, "ipv6": false, "lastModified": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/properties/origin", "rel": "self" } ], "livenessTests": [ { "disableNonstandardPortWarning": false, "hostHeader": "foo.example.com", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "health-check", "requestString": null, "responseString": null, "sslClientCertificate": null, "sslClientPrivateKey": null, "testInterval": 60, "testObject": "/status", "testObjectPassword": null, "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": null, "testTimeout": 10 } ], "loadImbalancePercentage": null, "mapName": null, "maxUnreachablePenalty": null, "mxRecords": [], "name": "origin", "scoreAggregationType": "mean", "staticTTL": 600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 3134, "enabled": true, "handoutCName": null, "name": null, "servers": [ "192.0.2.4" ], "weight": 50 }, { "datacenterId": 3133, "enabled": true, "handoutCName": null, "name": null, "servers": [ "192.0.2.102" ], "weight": 50 } ], "type": "weighted-round-robin", "unreachableThreshold": null, "useComputedTargets": false }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.0.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "requestString": "string", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 80, "testObjectProtocol": "HTTP", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [ { "exchange": "string", "preference": 0 } ], "name": "string", "scoreAggregationType": "mean", "staticTTL": 3600, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "servers": [ "string" ], "weight": 0 } ], "type": "performance", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": null, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": null, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": "string", "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "resource": { "backupCName": "string", "backupIp": "string", "balanceByDownloadScore": true, "cname": "string", "comments": null, "dynamicTTL": 30, "failbackDelay": 0, "failoverDelay": 0, "ghostDemandReporting": false, "handoutLimit": 8, "handoutMode": "normal", "healthMax": 0, "healthMultiplier": 0, "healthThreshold": 0, "ipv6": true, "lastModified": "2025-05-12T19:36:44Z", "links": [ { "href": "string", "rel": "string" } ], "livenessTests": [ { "alternateCACertificates": [ "myAlternateCACertificates", "myAlternateCACertificates2" ], "answersRequired": true, "disableNonstandardPortWarning": true, "disabled": true, "errorPenalty": 0, "hostHeader": "string", "httpError3xx": true, "httpError4xx": true, "httpError5xx": true, "httpHeaders": [ { "name": "string", "value": "string" } ], "httpMethod": "TRACE", "httpRequestBody": "string", "name": "string", "peerCertificateVerification": true, "pre2023SecurityPosture": false, "recursionRequested": true, "requestString": "string", "resourceType": "A", "responseString": "string", "sslClientCertificate": "string", "sslClientPrivateKey": "string", "testInterval": 10, "testObject": "string", "testObjectPassword": "string", "testObjectPort": 53, "testObjectProtocol": "DNS", "testObjectUsername": "string", "testTimeout": 10, "timeoutPenalty": 0 } ], "loadImbalancePercentage": 0, "mapName": "string", "maxUnreachablePenalty": 0, "minActiveDatacenterFraction": null, "minLiveFraction": 0, "mxRecords": [], "name": "string", "scoreAggregationType": "mean", "stateChangeNotificationWebhook": null, "staticRRSets": [ { "rdata": [ "string" ], "ttl": 3600, "type": "MX" } ], "staticTTL": null, "stickinessBonusConstant": 0, "stickinessBonusPercentage": 0, "trafficTargets": [ { "datacenterId": 0, "enabled": true, "handoutCName": null, "handoutRRSets": [ { "rdata": [ "192.0.2.1" ], "ttl": 60, "type": "A" }, { "rdata": [ "2001:db8::1" ], "ttl": 60, "type": "AAAA" } ], "name": "string", "precedence": 3, "servers": [ "string" ], "weight": 0 } ], "type": "ranked-failover", "unreachableThreshold": 0, "useComputedTargets": true }, "status": { "changeId": "eee0c3b4-0e45-4f4b-822c-7dbc60764d18", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.8.yaml" } } } }, "description": "The property was created successfully.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create or update a property", "tags": [ "Properties" ] }, "delete": { "description": "Removes a specific GTM property.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/delete-property" }, "operationId": "delete-property", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/property-vnd-config-gtm.v1.0+json": { "example": { "resource": null, "status": { "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T12:52:46.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, or `performance-with-load-feedback`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.0", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.0.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.0.yaml" } } }, "application/property-vnd-config-gtm.v1.1+json": { "example": { "resource": null, "status": { "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T12:52:46.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.1", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.1.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.1.yaml" } } }, "application/property-vnd-config-gtm.v1.2+json": { "example": { "resource": null, "status": { "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T12:52:46.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, "type": "array" }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests" ], "type": "object" } ], "title": "Property v1.2", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.2.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.2.yaml" } } }, "application/property-vnd-config-gtm.v1.3+json": { "example": { "resource": null, "status": { "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T12:52:46.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.3", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.3.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.3.yaml" } } }, "application/property-vnd-config-gtm.v1.4+json": { "example": { "resource": null, "status": { "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T12:52:46.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, or `asmapping`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.4", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.4.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.4.yaml" } } }, "application/property-vnd-config-gtm.v1.5+json": { "example": { "resource": null, "status": { "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T12:52:46.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, or `static`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.5", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.5.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.5.yaml" } } }, "application/property-vnd-config-gtm.v1.6+json": { "example": { "resource": null, "status": { "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T12:52:46.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, "type": "array" }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.6", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.6.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.6.yaml" } } }, "application/property-vnd-config-gtm.v1.7+json": { "example": { "resource": null, "status": { "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T12:52:46.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.7", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.7.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.7.yaml" } } }, "application/property-vnd-config-gtm.v1.8+json": { "example": { "resource": null, "status": { "changeId": "426e9ea3-c968-47df-a41b-43a993c6f873", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T12:52:46.000+0000" } }, "schema": { "additionalProperties": true, "properties": { "resource": { "allOf": [ { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "backupCName": { "description": "Specifies a `backupCName`. If GTM declares that all of the servers configured for your property are down, and you configured a `backupCName`, then queries for the property return the `backupCName`. If a `backupCName` is set, don't set a `backupIp`.", "nullable": true, "type": "string" }, "backupIp": { "description": "Specifies a backup IP. When GTM declares that all of the targets are down, it hands out the `backupIP`. The IP type coincides with the property's `iPv6` setting. If a `backupIp` is set, don't set a `backupCName`.", "nullable": true, "type": "string" }, "balanceByDownloadScore": { "description": "Indicates whether download score based load balancing is enabled. GTM estimates the load on your data centers based on how long they take to respond to GTM liveness tests. The advantage: you don't need to implement a load object. The disadvantage: it's a very crude measure of load, and usually highly nonlinear. As load increases, download times don't increase significantly, until there's too much load. When that happens, the download times skyrocket. This can easily cause erratic load balancing or load oscillations.", "type": "boolean" }, "cname": { "description": "Indicates the fully qualified name aliased to a particular property. The public name of the property.", "nullable": true, "type": "string" }, "comments": { "description": "Provides information about the purpose of the property.", "nullable": true, "type": "string" }, "dynamicTTL": { "default": 60, "description": "Indicates the TTL in seconds for records that might change dynamically based on liveness and load balancing such as A and AAAA records, and CNAMEs. The value ranges from `30` to `3600` and can change on request. The default is `60`.", "maximum": 3600, "minimum": 30, "type": "integer" }, "failbackDelay": { "description": "Specifies the failback delay in seconds. The minimum value is `0`. If specified, when a server has been down and comes back up, (that is, its liveness test starts succeeding again), GTM only considers it up after the failback delay has elapsed and tests continue to succeed.", "minimum": 0, "nullable": true, "type": "integer" }, "failoverDelay": { "description": "Specifies the failover delay in seconds. The minimum value is `0`. If specified, when a server begins failing its liveness test, GTM only considers it down after the failover delay has elapsed and the errors persist.", "minimum": 0, "nullable": true, "type": "integer" }, "handoutMode": { "default": "normal", "description": "Specifies how IPs are returned when more than one IP is alive and available. Possible values are: `normal`, `persistent`, `one-ip`, `one-ip-hashed`, or `all-live-ips`. The default is `normal`. Handout mode is relevant only when you have more than one server IP in a data center.", "enum": [ "normal", "persistent", "one-ip", "one-ip-hashed", "all-live-ips" ], "type": "string" }, "healthMax": { "description": "Defines the absolute limit beyond which IPs are declared unhealthy. If backup CNAMEs are provided for a property, then it's reasonable for all IPs to be declared unhealthy. The `healthMax` value is multiplied by the smaller of the `timeoutPenalty` and the `errorPenalty`. This check declares as down any server with a score greater than this product. The default value is `null`.", "nullable": true, "type": "number" }, "healthMultiplier": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. The cutoff is computed from the minimum score across all data centers, for a given property and two object fields: `healthMultiplier` and `healthThreshold`. The cutoff is either `healthMultiplier` (default value: 1.5) times the minimum score, or the `healthThreshold` (default value: 4), whichever is greater. See also `healthThreshold` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "healthThreshold": { "description": "Configures a cutoff value that's computed from the median scores. Any server with a score over the cutoff value is considered down, and load isn't sent to it. See also `healthMultiplier` within this object. For more information on how to determine server liveness, see the [Global Traffic Management User Guide](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "nullable": true, "type": "number" }, "ipv6": { "description": "Indicates the type of IP address handed out by a property. A `true` value indicates that all IP addresses specified are IPv6, and all hostnames need to resolve to AAAA records. A `false` value indicates IPv4 addresses, and all hostnames need to resolve to A records.", "type": "boolean" }, "lastModified": { "description": "An ISO 8601 timestamp indicating when the property was last changed.", "nullable": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the property.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "mapName": { "description": "A descriptive label for a geographic map or a CIDR map that's required if the property is either `geographic` or `cidrmapping`, in which case `mapName` needs to reference either an existing geographic map or CIDR map in the same domain.", "nullable": true, "type": "string" }, "maxUnreachablePenalty": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value. The penalty value is either `maxUnreachablePenalty` (minimum value is `0` and the default is `null`) or `unreachableThreshold` (decimal between `0` and `1`. A value of 1.0 or `null` disables an unreachable penalty). See also `unreachableThreshold` within this object.", "minimum": 0, "nullable": true, "type": "number" }, "mxRecords": { "description": "Specifies the MX records handed out to `MX` record type queries. Note that mapping and liveness testing aren't done. The same MX records are handed out for every request.", "items": { "additionalProperties": false, "properties": { "exchange": { "description": "MX record exchange field.", "type": "string" }, "preference": { "description": "MX record preference field.", "type": "number" } }, "required": [ "exchange", "preference" ], "type": "object" }, "type": "array" }, "name": { "description": "The value, together with the full GTM `domainName`, forms the property's hostname. The value should not begin or end with a dot character and needs to be a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. Set the name to `@` if the property is to be located at the apex of the domain.", "oneOf": [ { "format": "hostname", "title": "Hostname", "type": "string" }, { "enum": [ "@" ], "title": "apex", "type": "string" } ] }, "scoreAggregationType": { "default": "worst", "description": "Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Possible values are: `mean`, `median`, `best`, or the default `worst`.", "enum": [ "mean", "median", "best", "worst" ], "type": "string" }, "staticTTL": { "description": "Specifies the TTL in seconds for static resource records that don't change based on the requesting name server IP. This includes MX, TXT, and SPF records.", "maximum": 3600, "minimum": 30, "nullable": true, "type": "integer" }, "stickinessBonusConstant": { "description": "Specifies a constant used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `30000`. See also `stickinessBonusPercentage` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 30000, "minimum": 0, "nullable": true, "type": "integer" }, "stickinessBonusPercentage": { "description": "Specifies a percentage used to configure data center affinity. This only applies if the property `type` is `performance` and the domain `type` is `full`. The value ranges from `0` to `100`. See also `stickinessBonusConstant` within this object. To learn more about how these object fields relate to each other, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "maximum": 100, "minimum": 0, "nullable": true, "type": "integer" }, "unreachableThreshold": { "description": "For `performance` domains, this specifies a penalty value that's added to liveness test scores when data centers have an aggregated loss fraction higher than this value. The value is a decimal between `0` and `1`. A value of `1.0` or `null` disables an unreachable penalty. See also `maxUnreachablePenalty` within this object.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "useComputedTargets": { "description": "For `load-feedback` domains only, this specifies that you want GTM to automatically compute target load. Report only the current load objects, either by omission, or by using non-XML load objects.", "type": "boolean" } }, "required": [ "backupCName", "backupIp", "dynamicTTL", "failbackDelay", "failoverDelay", "handoutMode", "ipv6", "mapName", "mxRecords", "name", "scoreAggregationType", "staticTTL" ], "type": "object", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm-nested-not-versioned.v1.0.yaml" } }, { "additionalProperties": true, "description": "The entire GTM property configuration.", "properties": { "ghostDemandReporting": { "description": "__v1.3__ Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "handoutLimit": { "description": "__v1.3__ Indicates the limit for the number of live IPs handed out to a DNS request. The `handoutLimit` applies only if `handoutMode` is set to either `normal` or `persistent` for the property. If applicable, the `handoutLimit` default value is `8` or `null` if not.", "minimum": 1, "nullable": true, "type": "integer", "x-akamai": { "labels": [ "v1.3" ] } }, "livenessTests": { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disableNonstandardPortWarning": { "default": false, "description": "Disables warnings when non-standard ports are used. For example, GTM doesn't emit a warning to specify port 1234 when the `testObjectProtocol` is `http`, as HTTP typically uses port 80. The default is `false`.", "type": "boolean" }, "hostHeader": { "description": "Sent if the `testObjectProtocol` is `http` or `https`, up to 256 non-space, alphanumeric characters. Obsolete as of version 1.4. You should use `hostHeaders` instead.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "httpError3xx": { "description": "Treats a 3xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError4xx": { "description": "Treats a 4xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "httpError5xx": { "description": "Treats a 5xx HTTP response as a failure if the `testObjectProtocol` is `http`, `https`, or `ftp`.", "type": "boolean" }, "name": { "description": "A descriptive name for the liveness test.", "maxLength": 128, "minLength": 1, "type": "string" }, "requestString": { "description": "Specifies a request string. Required if `testObjectProtocol` is `tcp` or `tcps`. The value is a maximum of 4000 non-space, alphanumeric characters.", "maxLength": 4000, "minLength": 1, "nullable": true, "type": "string" }, "responseString": { "description": "Specifies a response string. Required if `testObjectProtocol` is `tcp` or `tcps`. Maximum 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string" }, "sslClientCertificate": { "description": "Indicates a Base64-encoded certificate. SSL client certificates are available for `livenessTests` that use secure protocols.", "nullable": true, "type": "string" }, "sslClientPrivateKey": { "description": "Indicates a Base64-encoded private key. The private key used to generate or request a certificate for `livenessTests` can't have a passphrase nor be used for any other purpose.", "nullable": true, "type": "string" }, "testInterval": { "description": "Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.", "minimum": 10, "type": "integer" }, "testObject": { "description": "Specifies the static text that acts as a stand-in for the data that you're sending on the network.", "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPassword": { "description": "Specifies the test object's password. It's required if `testObjectProtocol` is `ftp`. Maximum is 128 characters.", "maxLength": 128, "minLength": 1, "nullable": true, "type": "string" }, "testObjectPort": { "description": "Specifies the port number for the `testObject`. Value from `1` to `65535`.", "maximum": 65535, "minimum": 1, "type": "integer" }, "testObjectProtocol": { "description": "Specifies the test protocol. Possible values are: `DNS`, `DOH`, `DOT`, `HTTP`, `HTTPS`, `HTTP2`, `HTTP2S`, `FTP`, `POP`, `POPS`, `SMTP`, `SMTPS`, `TCP`, or `TCPS`. To enable `testObjectProtocol` for `DNS`, `DOH`, or `DOT` requires `application/vnd.config-gtm.v1.3+json`.", "enum": [ "DNS", "DOH", "DOT", "HTTP", "HTTPS", "HTTP2", "HTTP2S", "FTP", "POP", "POPS", "SMTP", "SMTPS", "TCP", "TCPS" ], "type": "string" }, "testObjectUsername": { "description": "A descriptive name for the `testObject`. If `testObjectProtocol` is `ftp`, then you need to specify a `testObjectUsername`. The value is a maximum of 256 non-space, alphanumeric characters.", "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" }, "testTimeout": { "description": "Specifies the duration of the liveness test before it fails. The range is from `0.001` to `60` seconds.", "maximum": 60, "minimum": 0.001, "type": "number" } }, "required": [ "disableNonstandardPortWarning", "hostHeader", "httpError3xx", "httpError4xx", "httpError5xx", "name", "requestString", "responseString", "sslClientCertificate", "sslClientPrivateKey", "testInterval", "testObject", "testObjectPassword", "testObjectPort", "testObjectProtocol", "testObjectUsername", "testTimeout" ], "type": "object", "x-akamai": { "file-path": "schemas/liveness-test-v1.0.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "errorPenalty": { "default": 75, "description": "__v1.2__ Specifies the score that's reported if the liveness test encounters an error other than timeout, such as connection refused, and 404. The default value is `75`.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } }, "timeoutPenalty": { "default": 25, "description": "__v1.2__ Specifies the score reported if the liveness test times out. This is independent of the liveness `testTimeout` value. The default value is `25` seconds.", "minimum": 0, "type": "number", "x-akamai": { "labels": [ "v1.2" ] } } }, "required": [ "errorPenalty", "timeoutPenalty" ], "type": "object" } ], "title": "livenessTest v1.2", "x-akamai": { "file-path": "schemas/liveness-test-v1.2.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "answersRequired": { "default": false, "description": "__v1.3__ If `testObjectProtocol` is `DNS`, `DOH` or `DOT`, requires an answer to the DNS query to be considered a success. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "peerCertificateVerification": { "default": false, "description": "__v1.3__ Validates the origin certificate. Applies only to tests with `testObjectProtocol` of `https`. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "recursionRequested": { "default": false, "description": "__v1.3__ Indicates that if `testObjectProtocol` is `DNS`, `DOH` or `DOT`, the `DNS` query is recursive. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.3" ] } }, "resourceType": { "description": "__v1.3__ Specifies the query type, if `testObjectProtocol` is `DNS`. Possible values are: `A`, `AAAA`, `AFSDB`, `CNAME`, `HINFO`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SPF`, `SRV`, `SSHFP`, `TXT`, `DNSKEY`, `DS`, `NSEC3`, `NSEC3PARAM`, or `RRSIG`. Unknown types `TYPENNNNN` are also supported, where `NNNNN` is an integer from `1` through `65535`.", "enum": [ "A", "AAAA", "AFSDB", "CNAME", "HINFO", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SPF", "SRV", "SSHFP", "TXT", "DNSKEY", "DS", "NSEC3", "NSEC3PARAM", "RRSIG" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.3" ] } } }, "required": [ "answersRequired", "resourceType", "recursionRequested", "peerCertificateVerification" ], "type": "object" } ], "title": "livenessTest v1.3", "x-akamai": { "file-path": "schemas/liveness-test-v1.3.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "disabled": { "default": false, "description": "__v1.4__ Disables the liveness test. When disabled, GTM stops running the test, treating it as if it no longer exists. The default is `false`.", "type": "boolean", "x-akamai": { "labels": [ "v1.4" ] } }, "httpHeaders": { "description": "__v1.4__ HTTP headers to send if the `testObjectProtocol` is `http` or `https`. This `hostHeader` is deprecated as of version 1.4.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Name of the HTTP header.", "minLength": 1, "type": "string" }, "value": { "description": "Value of the HTTP header.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "title": "livenessTest v1.4", "x-akamai": { "file-path": "schemas/liveness-test-v1.4.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "alternateCACertificates": { "description": "__v1.5__ Alternate trust anchors, Base64-encoded CA certificates. Available for `livenessTests` that use secure protocols.", "items": { "type": "string" }, "type": "array", "x-akamai": { "labels": [ "v1.5" ] } }, "httpMethod": { "default": "GET", "description": "__v1.5__ The HTTP method to send if the `testObjectProtocol` is `http` or `https`. Possible values are: `TRACE`, `HEAD`, `OPTIONS`, `GET`, `PUT`, `POST`, `PATCH`, or `DELETE`. When omitted or `null`, this value defaults to `GET`.", "enum": [ "TRACE", "HEAD", "OPTIONS", "GET", "PUT", "POST", "PATCH", "DELETE" ], "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } }, "httpRequestBody": { "description": "__v1.5__ The Base64-encoded HTTP request body to send if the `testObjectProtocol` is `http` or `https`. When omitted or `null`, omits the request body from the request.", "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.5" ] } } }, "type": "object" } ], "title": "livenessTest v1.5", "x-akamai": { "file-path": "schemas/liveness-test-v1.5.yaml" } }, { "additionalProperties": true, "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "properties": { "pre2023SecurityPosture": { "default": false, "description": "__v1.6__ Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.", "type": "boolean", "x-akamai": { "labels": [ "v1.6" ] } } }, "type": "object" } ], "title": "livenessTest v1.6", "x-akamai": { "file-path": "schemas/liveness-test-v1.6.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "type": "object" } ], "title": "livenessTest v1.7", "x-akamai": { "file-path": "schemas/liveness-test-v1.7.yaml" } }, { "description": "Liveness tests, which run periodically to determine whether your servers respond to requests.", "type": "object" } ], "title": "livenessTest v1.8", "x-akamai": { "file-path": "schemas/liveness-test-v1.8.yaml" } }, "type": "array" }, "minActiveDatacenterFraction": { "default": null, "description": "__v1.7__ The fraction of data centers that must be passing their liveness tests in order for the selection of live data centers to occur. For example, if this is set to `0.75` and only half the data centers are passing their liveness tests, then all data centers are handed out regardless of liveness test results. A `null` or `0` value means the feature is disabled and behavior is unchanged. The default value is `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.7" ] } }, "minLiveFraction": { "description": "__v1.3__ Specifies what fraction of the servers need to respond to requests so GTM considers the data center up and able to receive traffic. For example, if your data center contains eight servers, and the `minLiveFraction` value is `0.5`, then at least four servers need to respond to requests. Conversely, if five servers are down, and three servers are up, then GTM considers the entire data center down. Optional when a `minLiveFraction` value exists or not `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number", "x-akamai": { "labels": [ "v1.3" ] } }, "stateChangeNotificationWebhook": { "additionalProperties": false, "description": "__v1.7__ Configures a webhook to receive notifications when the property's state changes. Set to `null` to disable notifications.", "nullable": true, "properties": { "format": { "default": "json-compact", "description": "The format of the notification payload. Possible values are: `json-compact`, `json-pretty`, or `slack-mrkdwn`. The default value is `json-compact`.", "enum": [ "json-compact", "json-pretty", "slack-mrkdwn" ], "type": "string" }, "url": { "description": "The URL to send the notification to. Only `http`, `https`, and `mailto` schemes are allowed. If the host is a name, it must resolve to a routable address. If the host is an IP address, it must be routable.", "maxLength": 1024, "type": "string" } }, "required": [ "url" ], "type": "object", "x-akamai": { "labels": [ "v1.7" ] } }, "staticRRSets": { "description": "__v1.4__ Static recordsets. Use this instead of `mxRecords` and `staticTTL`, which were deprecated in version 1.4.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings, representing multiple records within a set. The format of the `rdata` strings are dependent on the `type` of this record.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The number of seconds that this record should live in a resolver's cache before being refetched.", "type": "integer" }, "type": { "description": "The record type.", "type": "string" } }, "required": [ "type", "ttl", "rdata" ], "type": "object" }, "type": "array", "x-akamai": { "labels": [ "v1.4" ] } }, "trafficTargets": { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "enabled": { "description": "Indicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the `false` value. However, when the value is `false`, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.", "type": "boolean" }, "handoutCName": { "description": "Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "An alternative label for the traffic target.", "nullable": true, "type": "string" }, "servers": { "description": "Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.", "items": { "type": "string" }, "type": "array" }, "weight": { "description": "Specifies the traffic weight for the target. This is required when the enclosing property is `failover`, `weighted`, `weighted-with-load-feedback`, or `performance`. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For `failover` properties, set this value to `1` for the traffic target you want to mark as _primary_.", "minimum": 0, "type": "number" } }, "type": "object", "x-akamai": { "file-path": "schemas/traffic-target-v1.0.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "precedence": { "description": "For use by `ranked-failover` type properties, the lower the number, the higher the precedence.", "maximum": 255, "minimum": 0, "type": "number" } }, "type": "object" } ], "title": "traffic target v1.6", "x-akamai": { "file-path": "schemas/traffic-target-v1.6.yaml" } }, { "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "type": "object" } ], "title": "traffic target v1.7", "x-akamai": { "file-path": "schemas/traffic-target-v1.7.yaml" } }, { "additionalProperties": true, "description": "This specifies where to direct data center traffic. For geographic mapped properties, it's always a `cname`. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.", "properties": { "handoutCName": { "deprecated": true, "description": "__Deprecated__ Use `handoutRRSets` instead. Specifies an optional data center for the property. Uses the `handoutCName` when there are no servers configured for the property. If both `handoutCName` and `handoutRRSets` are set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value.", "maxLength": 255, "nullable": true, "type": "string", "x-akamai": { "status": "DEPRECATED" } }, "handoutRRSets": { "description": "__v1.8__ An array of DNS recordsets to hand out for this traffic target. Each recordset contains a DNS record `type`, an array of `rdata` strings, and a `ttl`. Replaces the recated `handoutCName` field, enabling richer DNS responses such as A, AAAA, TXT, and other record types in addition to CNAME. If `handoutCName` is also set, `handoutRRSets` must contain a single CNAME record matching the `handoutCName` value. For non-CNAME handouts, `handoutCName` must be `null`.", "items": { "additionalProperties": false, "properties": { "rdata": { "description": "An array of data strings for this recordset. The format depends on the record `type`.", "items": { "type": "string" }, "type": "array" }, "ttl": { "description": "The time to live in seconds for this recordset.", "minimum": 0, "type": "integer" }, "type": { "description": "The DNS record type. Valid values are: `A`, `AAAA`, `AFSDB`, `CAA`, `CNAME`, `HINFO`, `HTTPS`, `LOC`, `MX`, `NAPTR`, `NS`, `PTR`, `RP`, `SOA`, `SVCB`, or `TXT`.", "enum": [ "A", "AAAA", "AFSDB", "CAA", "CNAME", "HINFO", "HTTPS", "LOC", "MX", "NAPTR", "NS", "PTR", "RP", "SOA", "SVCB", "TXT" ], "type": "string" } }, "required": [ "type", "rdata", "ttl" ], "type": "object" }, "nullable": true, "type": "array", "x-akamai": { "labels": [ "v1.8" ] } } }, "type": "object" } ], "title": "traffic target v1.8", "x-akamai": { "file-path": "schemas/traffic-target-v1.8.yaml" } }, "type": "array" }, "type": { "description": "Specifies the load balancing behavior for the property. Possible values are: `failover`, `geographic`, `cidrmapping`, `weighted-round-robin`, `weighted-hashed`, `weighted-round-robin-load-feedback`, `qtr`, `performance`, `performance-with-load-feedback`, `asmapping`, `static`, or `ranked-failover`. See [API versioning](https://techdocs.akamai.com/gtm/reference/api-versioning) for more information.", "enum": [ "failover", "geographic", "cidrmapping", "weighted-round-robin", "weighted-hashed", "weighted-round-robin-load-feedback", "qtr", "performance", "performance-with-load-feedback", "asmapping", "static", "ranked-failover" ], "type": "string" } }, "required": [ "type", "trafficTargets", "livenessTests", "handoutLimit" ], "type": "object" } ], "title": "Property v1.8", "x-akamai": { "file-path": "schemas/property-vnd-config-gtm.v1.8.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-property-response-v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "Remove a property", "tags": [ "Properties" ] }, "parameters": [ { "description": "A unique name for the property that when joined to the `domainName` with a dot separator, it forms a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname.", "example": "{{propertyName}}", "in": "path", "name": "propertyName", "required": true, "schema": { "example": "www", "type": "string" }, "x-akamai": { "file-path": "parameters/property-name-path.yaml" } }, { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/property.yaml", "path-info": "/domains/{domainName}/properties/{propertyName}" } }, "/domains/{domainName}/resources": { "get": { "description": "Returns a list of resources created within the domain that constrain one or more properties in a data center.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-resources" }, "operationId": "get-resources", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.88" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.145" ], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 } ] }, "schema": { "additionalProperties": true, "properties": { "items": { "description": "The list of a domain's resources.", "items": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-all-resources.yaml" } } } }, "description": "Successful response." } }, "summary": "List resources", "tags": [ "Resources" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/resources.yaml", "path-info": "/domains/{domainName}/resources" } }, "/domains/{domainName}/resources/{resourceName}": { "get": { "description": "Returns information for a specific resource.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-resource" }, "operationId": "get-resource", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aggregationType": "latest", "constrainedProperty": "**", "decayRate": null, "description": "Supply levels of Arbor Gold", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/arbor-gold", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "arbor-gold", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.111" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/cups", "loadObjectPort": 80, "loadServers": [ "192.0.2.187" ], "useDefaultLoadObject": false } ], "type": "Non-XML load object via HTTP", "upperBound": 0 }, "schema": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a resource", "tags": [ "Resources" ] }, "put": { "description": "Run this operation to create or update a resource.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/put-resource" }, "operationId": "put-resource", "parameters": [ { "description": "Specifies change descriptions for audit trail and domain's change history. The maximum is 4000 characters.", "example": "{{domainModificationComments}}", "in": "query", "name": "domainModificationComments", "schema": { "example": "Load balancer policy change", "maxLength": 4000, "nullable": true, "type": "string" }, "x-akamai": { "file-path": "parameters/domain-modification-comments-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "Disk utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "disk", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/disk", "loadObjectPort": 80, "loadServers": [ "192.0.2.154" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/disk", "loadObjectPort": 80, "loadServers": [ "192.0.2.118" ], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, "schema": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "example": "{{aggregationType}}", "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "example": "{{constrainedProperty}}", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "example": "{{decayRate}}", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "example": "{{description}}", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "example": "{{hostHeader}}", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "example": "{{leaderString}}", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "example": "{{leastSquaresDecay}}", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "example": "{{loadImbalancePercentage}}", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "example": "{{maxUMultiplicativeIncrement}}", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "example": "{{name}}", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "example": "{{type}}", "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "example": "{{upperBound}}", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "resource": { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "Disk utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/disk", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "disk", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/disk", "loadObjectPort": 80, "loadServers": [ "192.0.2.195" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/disk", "loadObjectPort": 80, "loadServers": [ "192.0.2.3" ], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, "status": { "changeId": "79255c00-f6b6-48ea-9d67-c6d02a8742c9", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-resource-response.yaml" } } } }, "description": "The resource was updated successfully." }, "201": { "content": { "application/json": { "example": { "resource": { "aggregationType": "latest", "constrainedProperty": "mail", "decayRate": null, "description": "Disk utilization", "hostHeader": null, "leaderString": null, "leastSquaresDecay": null, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/resources/disk", "rel": "self" } ], "loadImbalancePercentage": null, "maxUMultiplicativeIncrement": null, "name": "disk", "resourceInstances": [ { "datacenterId": 3134, "loadObject": "/disk", "loadObjectPort": 80, "loadServers": [ "192.0.2.195" ], "useDefaultLoadObject": false }, { "datacenterId": 3133, "loadObject": "/disk", "loadObjectPort": 80, "loadServers": [ "192.0.2.3" ], "useDefaultLoadObject": false } ], "type": "XML load object via HTTP", "upperBound": 0 }, "status": { "changeId": "79255c00-f6b6-48ea-9d67-c6d02a8742c9", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "additionalProperties": false, "description": "The resources in the GTM domain.", "nullable": true, "properties": { "aggregationType": { "description": "Specifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Possible values are: `sum`, `median`, or `latest`. For test time load feedback, consider `median`. (Akamai conducts tests from multiple locations, so you can ignore outlying values.) For load feedback with manual targets or dynamic targets, consider `latest` because all load servers normally report similar numbers.", "enum": [ "sum", "median", "latest" ], "maxLength": 15, "type": "string" }, "constrainedProperty": { "description": "Specifies the name of the property that this resource constrains, or `**` to constrain all properties. To remove the property constraint, set the field to `null`.", "maxLength": 256, "nullable": true, "type": "string" }, "decayRate": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "description": { "description": "A descriptive note to help you track what the resource constrains. For example, `aggregate bandwidth for all properties`. A maximum of 256 characters.", "maxLength": 256, "nullable": true, "type": "string" }, "hostHeader": { "description": "Optionally specifies the host header used when fetching the load object.", "maxLength": 255, "nullable": true, "type": "string" }, "leaderString": { "description": "Specifies the text that comes before the `loadObject`. GTM assumes that the current load is the first number to appear after this text, minus any white space. The value is a maximum of 256 characters. The default is `null`. For example, suppose your `loadObject` file contains, _This is a load object. TheLoadIs:497. This is the end of the load object_. Then GTM reads the current load as _497_ if the `leaderString` is set to _TheLoadIs_.", "maxLength": 256, "nullable": true, "type": "string" }, "leastSquaresDecay": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "maximum": 1, "minimum": 0, "nullable": true, "type": "number" }, "links": { "description": "Specifies the URL path that allows direct navigation to the resource.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "loadImbalancePercentage": { "description": "Indicates the percent of load imbalance factor (LIF) for the domain. It lets GTM exceed the value configured for traffic distribution. For example, if the data center's traffic allocation is 25 percent and the LIF is 1.5, the demand can grow to 37.5 percent (25% × 1.5) before the load balancer starts shifting load away from it. If the LIF is `0`, no load imbalance is allowed. However, internally, GTM adds one to the LIF to allow its use as a multiplier. The default LIF is 1.1, which is displayed as `10.0` percent. The value ranges from `0` to `1000000` percent.", "maximum": 1000000, "minimum": 0, "nullable": true, "type": "number" }, "maxUMultiplicativeIncrement": { "description": "For internal use only. Unless Akamai indicates otherwise, omit the value or set it to `null`.", "minimum": 1, "nullable": true, "type": "number" }, "name": { "description": "A descriptive label for the resource. A maximum 150 non-space characters.", "maxLength": 150, "pattern": "^((?!\\s).)*$", "type": "string" }, "resourceInstances": { "description": "The `resources` that constrain the `properties` within the data center.", "items": { "additionalProperties": false, "properties": { "datacenterId": { "description": "A unique identifier for an existing data center in the domain.", "type": "integer" }, "loadObject": { "description": "Identifies the load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource. The maximum permitted length is 256 characters. [Learn more](https://techdocs.akamai.com/gtm/docs/welcome-to-global-traffic-management).", "maxLength": 256, "nullable": true, "pattern": "^(?!:).*$", "type": "string" }, "loadObjectPort": { "description": "Specifies the TCP port of the `loadObject`. The value ranges from `0` to `65535`. If the value is `0`, the default port is either `80` or `443`.", "maximum": 65535, "minimum": 0, "type": "integer" }, "loadServers": { "description": "Specifies a list of servers from which to request the load object. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "useDefaultLoadObject": { "description": "Indicates whether a default `loadObject` is used for the resources.", "type": "boolean" } }, "required": [ "datacenterId" ], "type": "object" }, "type": "array" }, "type": { "description": "Indicates the kind of `loadObject` format used to determine the load on the resource. Possible values are: `XML load object via HTTP`, `XML load object via HTTPS`, `Non-XML load object via HTTP`, `Non-XML load object via HTTPS`, `Download score`, or `Push API`.", "enum": [ "XML load object via HTTP", "XML load object via HTTPS", "Non-XML load object via HTTP", "Non-XML load object via HTTPS", "Download score", "Push API" ], "type": "string" }, "upperBound": { "description": "An optional sanity check that specifies the maximum allowed value for any component of the load object. If the `loadObject` contains a number that exceeds this value, it rejects the entire load object as invalid and GTM continues to use the load values from the most recently acquired `loadObject`. To receive an alert when a load object is rejected, log in to [Control Center](https://control.akamai.com), select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. [Learn more](https://techdocs.akamai.com/alerts-app/docs).", "nullable": true, "type": "integer" } }, "required": [ "aggregationType", "name", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/resource.yaml" } }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/update-resource-response.yaml" } } } }, "description": "The resource was created successfully.", "headers": { "Location": { "schema": { "type": "string" } } } } }, "summary": "Create or update a resource", "tags": [ "Resources" ] }, "delete": { "description": "Removes a specific resource.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/delete-resource" }, "operationId": "delete-resource", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "resource": null, "status": { "changeId": "a97bedfe-c997-4634-84a4-cdb31529fb4c", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T13:44:53.000+0000" } }, "schema": { "additionalProperties": false, "properties": { "resource": { "description": "Reflects the data you just deleted.", "nullable": true, "type": "string" }, "status": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "__Read-only__ A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "readOnly": true, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "__Read-only__ A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "readOnly": true, "type": "string" }, "passingValidation": { "description": "__Read-only__ Indicates if the domain validates.", "readOnly": true, "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "__Read-only__ An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status.yaml" } } }, "type": "object", "x-akamai": { "file-path": "schemas/delete-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Remove a resource", "tags": [ "Resources" ] }, "parameters": [ { "description": "Name of the `resource` to create or update.", "example": "{{resourceName}}", "in": "path", "name": "resourceName", "required": true, "schema": { "example": "cpu", "type": "string" }, "x-akamai": { "file-path": "parameters/resource-name-path.yaml" } }, { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/resource.yaml", "path-info": "/domains/{domainName}/resources/{resourceName}" } }, "/domains/{domainName}/status/current": { "get": { "description": "This operation returns information about the current condition of the change in the domain's activation.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-status-current" }, "operationId": "get-status-current", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ], "message": "Current configuration has been propagated to all GTM name servers.", "passingValidation": true, "propagationStatus": "COMPLETE", "propagationStatusDate": "2014-03-08T15:39:00.000+0000" }, "schema": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "type": "string" }, "passingValidation": { "description": "Indicates if the domain validates.", "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Get current status", "tags": [ "Domains" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/current.yaml", "path-info": "/domains/{domainName}/status/current" } }, "/domains/{domainName}/status/{versionId}": { "get": { "description": "Returns the propagation status for a specific domain version, identified by its `changeId`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-status" }, "operationId": "get-status", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "rel": "self" } ], "message": "Current configuration has been propagated to all GTM name servers.", "passingValidation": true, "propagationStatus": "COMPLETE", "propagationStatusDate": "2014-03-08T15:39:00.000+0000" }, "schema": { "additionalProperties": false, "description": "The condition of the change in the domain's activation. Any change that returns a 200 series response and goes to propagationStatus PENDING, propagates within a few minutes. To query the activation status, run the [Get current status](https://techdocs.akamai.com/gtm/reference/get-status-current) operation, which returns information about the current condition of the change in the domain's activation.", "properties": { "changeId": { "description": "A unique identifier generated when a change occurs to the domain.", "maxLength": 36, "minLength": 36, "type": "string" }, "links": { "description": "Specifies the URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "message": { "description": "A notification generated when a change occurs to the domain. The maximum length is 4000 characters.", "maxLength": 4000, "type": "string" }, "passingValidation": { "description": "Indicates if the domain validates.", "type": "boolean" }, "propagationStatus": { "description": "Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string" }, "propagationStatusDate": { "description": "An ISO 8601 timestamp indicating when a change occurs to the domain.", "format": "date-time", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/status-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Get status for a domain version", "tags": [ "Domains" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } }, { "description": "Unique identifier for a domain version, returned as `changeId` in write operation responses.", "example": "{{versionId}}", "in": "path", "name": "versionId", "required": true, "schema": { "example": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "type": "string" }, "x-akamai": { "file-path": "parameters/version-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/status.yaml", "path-info": "/domains/{domainName}/status/{versionId}" } }, "/domains/{domainName}/summary": { "get": { "description": "Returns summary information for a specific GTM domain, including its activation state, last modification details, and DNSSEC configuration.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-domain-summary" }, "operationId": "get-domain-summary", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "domain-vnd-config-gtm.v1.0+json": { "example": { "acgId": "1-1TJZH5", "activationState": "COMPLETE", "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "deleteRequestId": null, "id": 3131, "lastModified": "2014-04-07T16:21:27.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": null, "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-01-03T22:00:55.000+0000 Successfully Validated and Propagated" }, "schema": { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } } }, "domain-vnd-config-gtm.v1.1+json": { "example": { "acgId": "1-1TJZH5", "activationState": "COMPLETE", "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "deleteRequestId": null, "id": 3131, "lastModified": "2014-04-07T16:21:27.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": null, "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-01-03T22:00:55.000+0000 Successfully Validated and Propagated" }, "schema": { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.1.yaml" } } }, "domain-vnd-config-gtm.v1.2+json": { "example": { "acgId": "1-1TJZH5", "activationState": "COMPLETE", "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "deleteRequestId": null, "id": 3131, "lastModified": "2014-04-07T16:21:27.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": null, "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-01-03T22:00:55.000+0000 Successfully Validated and Propagated" }, "schema": { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } } }, "domain-vnd-config-gtm.v1.3+json": { "example": { "acgId": "1-1TJZH5", "activationState": "COMPLETE", "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "deleteRequestId": null, "id": 3131, "lastModified": "2014-04-07T16:21:27.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": null, "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-01-03T22:00:55.000+0000 Successfully Validated and Propagated" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.3.yaml" } } }, "domain-vnd-config-gtm.v1.4+json": { "example": { "acgId": "1-1TJZH5", "activationState": "COMPLETE", "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "deleteRequestId": null, "id": 3131, "lastModified": "2014-04-07T16:21:27.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": null, "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-01-03T22:00:55.000+0000 Successfully Validated and Propagated" }, "schema": { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } } }, "domain-vnd-config-gtm.v1.5+json": { "example": { "acgId": "1-1TJZH5", "activationState": "COMPLETE", "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "deleteRequestId": null, "id": 3131, "lastModified": "2014-04-07T16:21:27.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": null, "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-01-03T22:00:55.000+0000 Successfully Validated and Propagated" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.5.yaml" } } }, "domain-vnd-config-gtm.v1.6+json": { "example": { "acgId": "1-1TJZH5", "activationState": "COMPLETE", "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "deleteRequestId": null, "id": 3131, "lastModified": "2014-04-07T16:21:27.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": null, "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-01-03T22:00:55.000+0000 Successfully Validated and Propagated" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.5.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.6.yaml" } } }, "domain-vnd-config-gtm.v1.7+json": { "example": { "acgId": "1-1TJZH5", "activationState": "COMPLETE", "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "deleteRequestId": null, "id": 3131, "lastModified": "2014-04-07T16:21:27.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": null, "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-01-03T22:00:55.000+0000 Successfully Validated and Propagated" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.5.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.6.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.7.yaml" } } }, "domain-vnd-config-gtm.v1.8+json": { "example": { "acgId": "1-1TJZH5", "activationState": "COMPLETE", "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "deleteRequestId": null, "id": 3131, "lastModified": "2014-04-07T16:21:27.000Z", "lastModifiedBy": "admin@example.com", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net", "rel": "self" } ], "modificationComments": null, "name": "example.akadns.net", "signAndServe": false, "signAndServeAlgorithm": null, "status": "2014-01-03T22:00:55.000+0000 Successfully Validated and Propagated" }, "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "allOf": [ { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "acgId": { "description": "The contract Id of the domain.", "type": "string" }, "deleteRequestId": { "description": "Unique identifier of the delete request associated with the domain. Used for tracking and auditing deletion operations within the system.", "nullable": true, "type": "string" }, "lastModified": { "description": "__Read-only__ An ISO 8601 timestamp indicating when the domain was last changed.", "readOnly": true, "type": "string" }, "links": { "description": "A URL path that allows direct navigation to the domain.", "items": { "additionalProperties": false, "description": "Lists navigable URLs to resources.", "properties": { "href": { "description": "Provides a hypermedia link to the complete URL that uniquely defines a resource.", "type": "string" }, "rel": { "description": "Indicates the link relationship of the object.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/link.yaml" } }, "type": "array" }, "name": { "description": "The full GTM domain name that needs to end in `.akadns.net`, up to 100 characters.", "maxLength": 100, "minLength": 1, "type": "string" }, "signAndServe": { "default": false, "description": "Whether DNSSEC Sign&Serve is enabled.", "type": "boolean" }, "signAndServeAlgorithm": { "description": "The algorithm currently or last used for DNSSEC Sign&Serve. The value is `null` if no algorithm has ever been assigned to this domain. Possible values are: `RSA_SHA1`, `RSA_SHA256`, `RSA_SHA512`, `ECDSA_P256_SHA256`, or `ECDSA_P384_SHA384`.", "enum": [ "RSA_SHA1", "RSA_SHA256", "RSA_SHA512", "ECDSA_P256_SHA256", "ECDSA_P384_SHA384" ], "nullable": true, "type": "string" }, "status": { "description": "Describes the status of the domain.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.0.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "activationState": { "description": "__v1.2__ Tracks the status of the domain's propagation state. Possible values are: `PENDING`, `COMPLETE`, or `DENIED`. A `DENIED` value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.", "enum": [ "PENDING", "COMPLETE", "DENIED" ], "maxLength": 20, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "changeId": { "description": "__v1.2__ The ID associated with the change.", "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "lastModifiedBy": { "description": "__v1.2__, __Read-only__ The email address of the administrator who made the last change to the domain.", "maxLength": 256, "nullable": true, "readOnly": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } }, "modificationComments": { "description": "__v1.2__ A descriptive note about changes to the domain. The maximum is 4000 characters.", "maxLength": 4000, "nullable": true, "type": "string", "x-akamai": { "labels": [ "v1.2" ] } } }, "type": "object" } ], "title": "Domain Summary v1.2", "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.2.yaml" } }, { "additionalProperties": true, "description": "Summary information about the domain.", "properties": { "id": { "description": "__v1.4__ The ID of the domain.", "type": "integer", "x-akamai": { "labels": [ "v1.4" ] } } }, "type": "object" } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.4.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.5.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.6.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.7.yaml" } } ], "x-akamai": { "file-path": "schemas/domain-summary-vnd-config-gtm.v1.8.yaml" } } } }, "description": "Successful response." } }, "summary": "Get a domain summary", "tags": [ "Domains" ] }, "parameters": [ { "description": "The full GTM domain name.", "example": "{{domainName}}", "in": "path", "name": "domainName", "required": true, "schema": { "example": "example.akadns.net", "type": "string" }, "x-akamai": { "file-path": "parameters/domain-name-path.yaml" } } ], "x-akamai": { "file-path": "paths/domain-summary.yaml", "path-info": "/domains/{domainName}/summary" } }, "/identity": { "get": { "description": "This operation returns information about the API client. Run this operation for details on the API client contract such as available load balancing `features` and `permissions` the client has on the domains tied to the contract.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-identity" }, "operationId": "get-identity", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT3456", "active": true, "contracts": [ { "contractId": "C-0N7RAC71", "features": [ "FAILOVER", "QTR", "ASMAPPING", "CIDRMAPPING", "GEOGRAPHIC", "WEIGHTED_ROUND_ROBIN", "WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK", "WEIGHTED_HASHED", "PERFORMANCE" ], "permissions": [ "READ", "WRITE", "ADD" ] }, { "contractId": "C-0N7RAC7", "features": [ "FAILOVER", "QTR", "ASMAPPING", "CIDRMAPPING", "GEOGRAPHIC" ], "permissions": [ "READ", "WRITE" ] } ], "email": "afero@example.com", "firstName": "Eddard", "lastName": "Stark", "locale": "en_US", "userName": "ed@example.com", "userTimeZone": "-05:00" }, "schema": { "additionalProperties": false, "description": "High-level information about the API client for a specific GTM account.", "properties": { "accountId": { "description": "A unique API client identity for a specific account, created in [Control Center](https://control.akamai.com/apps/home-page).", "type": "string" }, "active": { "description": "Enabled if the account is active.", "type": "boolean" }, "contracts": { "description": "Contracts under a specific account.", "items": { "additionalProperties": false, "properties": { "contractId": { "description": "A unique identifier for the contract.", "type": "string" }, "features": { "description": "Available property types for a specific domain. Any combination of `FAILOVER`, `RANKED_FAILOVER`, `QTR`, `STATIC`, `ASMAPPING`, `CIDRMAPPING`, `GEOGRAPHIC`, `WEIGHTED_ROUND_ROBIN`, `WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK`, `WEIGHTED_HASHED`, `PERFORMANCE`, `PERFORMANCE_WITH_LOAD_FEEDBACK`, `PERFORMANCE_WITH_LOAD_FEEDBACK_COMPUTED_TARGETS`, and `PERFORMANCE_WITH_LOAD_FEEDBACK_DOWNLOAD_SCORE` values.", "items": { "enum": [ "FAILOVER", "RANKED_FAILOVER", "QTR", "STATIC", "ASMAPPING", "CIDRMAPPING", "GEOGRAPHIC", "WEIGHTED_ROUND_ROBIN", "WEIGHTED_ROUND_ROBIN_LOAD_FEEDBACK", "WEIGHTED_HASHED", "PERFORMANCE", "PERFORMANCE_WITH_LOAD_FEEDBACK", "PERFORMANCE_WITH_LOAD_FEEDBACK_COMPUTED_TARGETS", "PERFORMANCE_WITH_LOAD_FEEDBACK_DOWNLOAD_SCORE" ], "type": "string" }, "type": "array" }, "permissions": { "description": "Privileges set for the contract, controlling the ability to modify or delete `properties`. Any combination of `READ`, `WRITE`, `ADD`, and `ADD_DATACENTER` values.", "items": { "enum": [ "READ", "WRITE", "ADD", "ADD_DATACENTER" ], "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "email": { "description": "The email address of the client on the account.", "type": "string" }, "firstName": { "description": "The first name of the client on the account.", "type": "string" }, "lastName": { "description": "The last name of the client on the account.", "type": "string" }, "locale": { "description": "Indicates the client's language and country in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.", "type": "string" }, "userName": { "description": "The username of the client on the account.", "type": "string" }, "userTimeZone": { "description": "The time zone of the client on the account, which specifies an offset from GTM.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/identity-response.yaml" } } } }, "description": "Successful response." } }, "summary": "Get identity", "tags": [ "Identity" ] }, "parameters": [ { "description": "A unique identifier for the group. If your GTM client credential has access to more than one group, you need to specify which group to assign to the domain. For more information, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "example": "{{gid}}", "in": "query", "name": "gid", "schema": { "example": 15166, "type": "integer" }, "x-akamai": { "file-path": "parameters/gid-query.yaml" } } ], "x-akamai": { "file-path": "paths/identity.yaml", "path-info": "/identity" } }, "/identity/contracts": { "get": { "description": "This operation returns a list of API client `contracts`. When you [Create a domain](https://techdocs.akamai.com/gtm/reference/post-domain), you may need a `contractId` under certain circumstances. Run this operation to view available values.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-identity-contracts" }, "operationId": "get-identity-contracts", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT1234", "contracts": [ { "contractId": "C-0N7RAC71", "contractName": "Wolves", "contractTypeName": "DIRECT_CUSTOMER" }, { "contractId": "C-0N7RAC71", "contractName": "Stags", "contractTypeName": "DIRECT_CUSTOMER" } ] }, "schema": { "additionalProperties": false, "description": "Contracts under a specific GTM account.", "properties": { "accountId": { "description": "A unique identifier for the account where the contract exists.", "type": "string" }, "contracts": { "description": "Contracts under a specific account.", "items": { "additionalProperties": false, "properties": { "contractId": { "description": "A unique identifier for the contract.", "type": "string" }, "contractName": { "description": "A descriptive name for the contract.", "type": "string" }, "contractTypeName": { "description": "A descriptive name for the contract type.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/identity-contracts-response.yaml" } } } }, "description": "Successful response." } }, "summary": "List contracts", "tags": [ "Contracts" ] }, "parameters": [ { "description": "A unique identifier for the group. If your GTM client credential has access to more than one group, you need to specify which group to assign to the domain. For more information, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "example": "{{gid}}", "in": "query", "name": "gid", "schema": { "example": 15166, "type": "integer" }, "x-akamai": { "file-path": "parameters/gid-query.yaml" } } ], "x-akamai": { "file-path": "paths/contracts.yaml", "path-info": "/identity/contracts" } }, "/identity/groups": { "get": { "description": "This operation returns a list of API client `groups` and their parameters. When you [Create a domain](https://techdocs.akamai.com/gtm/reference/post-domain), you may need a `groupId` under certain circumstances. Run this operation to view available values.", "externalDocs": { "description": "See documentation for this operation in Akamai's Global Traffic Management API", "url": "https://techdocs.akamai.com/gtm/reference/get-identity-groups" }, "operationId": "get-identity-groups", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "groups": [ { "contractIds": [ "K-0N7RAK71" ], "groupId": 54321, "groupName": "House Stark", "permissions": [ "ADD", "READ", "WRITE" ] }, { "contractIds": [ "K-0N7RAK71", "C-0N7RAC71" ], "groupId": 12345, "groupName": "House Baratheon", "permissions": [ "READ", "WRITE" ] } ] }, "schema": { "additionalProperties": false, "description": "Groups under a specific GTM account.", "properties": { "groups": { "description": "Groups under a specific GTM account. For details on how to modify group permissions, see the [Identity Management: User Administration API](https://techdocs.akamai.com/iam-user-admin/reference/api).", "items": { "additionalProperties": false, "properties": { "contractIds": { "description": "Unique identifiers for the contracts associated with the group.", "items": { "type": "string" }, "type": "array" }, "groupId": { "description": "A unique identifier for the group.", "type": "integer" }, "groupName": { "description": "A descriptive name for the group.", "type": "string" }, "permissions": { "description": "Privileges set for the group. Use these privileges to create a domain, modify, or delete any of the `properties` within a specific domain. Any combination of `READ`, `WRITE`, `ADD`, and `ADD_DATACENTER` values.", "items": { "enum": [ "READ", "WRITE", "ADD", "ADD_DATACENTER" ], "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/identity-groups-response.yaml" } } } }, "description": "Successful response." } }, "summary": "List groups", "tags": [ "Groups" ] }, "parameters": [ { "description": "A unique identifier for the group. If your GTM client credential has access to more than one group, you need to specify which group to assign to the domain. For more information, see [API concepts](https://techdocs.akamai.com/gtm/reference/api-concepts).", "example": "{{gid}}", "in": "query", "name": "gid", "schema": { "example": 15166, "type": "integer" }, "x-akamai": { "file-path": "parameters/gid-query.yaml" } } ], "x-akamai": { "file-path": "paths/groups.yaml", "path-info": "/identity/groups" } } }, "servers": [ { "url": "https://{hostname}/config-gtm/v1" } ], "tags": [], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }