Domain

NameTypeDescription
DomainObjectThe basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as example.akadns.net.
asMapsArrayFrom v1.1. The set of AS maps assigned to this domain.
asMaps[]ObjectFrom v1.1. The AS map configured for the property.
cidrMapsArrayThe set of CIDR maps assigned to this domain.
cidrMaps[]ObjectThe CIDR map configured for the property.
cnameCoalescingEnabledBooleanFrom v1.1. If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is false.
datacentersArrayThe set of data centers assigned to this domain.
datacenters[]ObjectThe data centers in the GTM domain.
defaultErrorPenaltyIntegerSpecifies 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.
defaultSslClientCertificateStringSpecifies 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 members 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.
defaultSslClientPrivateKeyStringSpecifies 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.
defaultTimeoutPenaltyIntegerSpecifies 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.
deleteRequestIdStringUnique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.
emailNotificationListArrayA list of email addresses to notify when a change is made to the domain.
geographicMapsArrayThe set of geographic maps assigned to this domain.
geographicMaps[]ObjectThe geographic map configured for the property.
lastModifiedStringAn ISO 8601 timestamp that indicates the time of the last domain change.
lastModifiedByStringThe email address of the administrator who made the last change to the domain.
linksArrayA URL path that allows direct navigation to the domain.
links[]ObjectLists navigable URLs to resources.
loadFeedbackBooleanIndicates 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.
loadImbalancePercentageNumberIndicates 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.
modificationCommentsStringA descriptive note about changes to the domain. The maximum is 4000 characters.
nameStringThe full GTM domain name that needs to end in .akadns.net, up to 100 characters.
propertiesArrayThe properties in the GTM domain.
properties[]ObjectThe entire GTM property configuration.
resourcesArrayThe resources in the GTM domain.
resources[]ObjectThe resources in the GTM domain.
signAndServeBooleanFrom v1.5. Whether DNSSEC Sign&Serve is enabled.
signAndServeAlgorithmStringFrom v1.5. The algorithm currently or last used for DNSSEC Sign&Serve. null if no algorithm has ever been assigned to this domain. Either RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384.
statusObjectThe 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 operation, which returns information about the current condition of the change in the domain's activation.
typeStringIndicates the type of domain available based on your contract. Either failover-only, static, weighted, basic, or full.
Domain.asMaps[]
assignmentsArrayFrom v1.1. The AS zone groupings of AS IDs.
assignments[]ObjectFrom v1.1. TBD.
defaultDatacenterObjectFrom v1.1. 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.
linksArrayFrom v1.1. Specifies the URL path that allows direct navigation to the AS map.
links[]ObjectFrom v1.1. Lists navigable URLs to resources.
nameStringFrom v1.1. A descriptive label for the AS map. Properties set up for asmapping can use this as reference.
Domain.asMaps[].assignments[]
asNumbersArrayFrom v1.1. Specifies an array of AS numbers.
datacenterIdIntegerFrom v1.1. A unique identifier for an existing data center in the domain.
nicknameStringFrom v1.1. A descriptive label for the group.
Domain.asMaps[].defaultDatacenter
datacenterIdIntegerFrom v1.1. For each property, an identifier for all other AS zones' CNAME. For example, 5400.
nicknameStringFrom v1.1. A descriptive label for all other AS zones, up to 128 characters. If the value is empty or null, the default is Default Mapping.
Domain.asMaps[].links[]
hrefStringFrom v1.1. Provides a hypermedia link to the complete URL that uniquely defines a resource.
relStringFrom v1.1. Indicates the link relationship of the object.
Domain.cidrMaps[]
assignmentsArrayThe CIDR zone groupings of CIDR blocks.
assignments[]ObjectTBD.
defaultDatacenterObjectA 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.
linksArraySpecifies the URL path that allows direct navigation to the CIDR map.
links[]ObjectLists navigable URLs to resources.
nameStringA descriptive label for the CIDR map, up to 255 characters.
Domain.cidrMaps[].assignments[]
blocksArraySpecifies an array of CIDR blocks.
datacenterIdIntegerA unique identifier for an existing data center in the domain.
nicknameStringA descriptive label for the CIDR zone group, up to 256 characters.
Domain.cidrMaps[].defaultDatacenter
datacenterIdIntegerFor each property, an identifier for all other CIDR zones' CNAME. For example, 5400.
nicknameStringA descriptive label for the all other CIDR blocks. If omitted, the default is All Other CIDR Blocks.
Domain.cidrMaps[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.datacenters[]
cityStringThe name of the city where the data center is located.
cloneOfIntegerIdentifies 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.
cloudServerHostHeaderOverrideBooleanFrom v1.3. Balances load between two or more servers in a cloud environment. Either true if cloud server targeting is enabled or false if not.
cloudServerTargetingBooleanBalances load between two or more servers in a cloud environment. Either true if cloud server targeting is enabled or false if not.
continentStringA two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Either AF, AS, EU, NA, OC, OT, or SA.
countryStringA two-letter ISO 3166 country code that specifies the country where the data center maps to.
datacenterIdIntegerA unique identifier for an existing data center in the domain.
defaultLoadObjectObjectSpecifies 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.
latitudeNumberSpecifies the geographical latitude of the data center's position. See also longitude within this object.
linksArrayA URL path that allows direct navigation to a data center.
links[]ObjectLists navigable URLs to resources.
longitudeNumberSpecifies the geographic longitude of the data center's position. See also latitude within this object.
nicknameStringA descriptive label for the data center.
scorePenaltyIntegerFrom 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.
stateOrProvinceStringSpecifies a two-letter ISO 3166 country code for the state or province where the data center is located.
virtualBooleanIndicates whether or not the data center is virtual or physical, the latter meaning the data center has an Akamai Network Agent installed, and its physical location in latitude and longitude is fixed. Either true if virtual or false if physical.
Domain.datacenters[].defaultLoadObject
loadObjectStringSpecifies 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.
loadObjectPortIntegerSpecifies 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.
loadServersArraySpecifies 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 addresses.
Domain.datacenters[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.geographicMaps[]
assignmentsArrayThe geographic zone groupings of countries.
assignments[]ObjectTBD.
defaultDatacenterObjectA 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.
linksArraySpecifies the URL path that allows direct navigation to the geographic map.
links[]ObjectLists navigable URLs to resources.
nameStringA descriptive label for the geographic map, up to 128 characters.
Domain.geographicMaps[].assignments[]
countriesArraySpecifies 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.
datacenterIdIntegerA unique identifier for an existing data center in the domain.
nicknameStringA descriptive label for the group.
Domain.geographicMaps[].defaultDatacenter
datacenterIdIntegerFor each property, an identifier for all other geographic zones' CNAME. For example, 5400.
nicknameStringA descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to Default Mapping.
Domain.geographicMaps[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.properties[]
backupCNameStringSpecifies 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.
backupIpStringSpecifies 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.
balanceByDownloadScoreBooleanIndicates 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.
cnameStringIndicates the fully qualified name aliased to a particular property. The public name of the property.
commentsStringProvides information about the purpose of the property.
dynamicTTLIntegerIndicates 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.
failbackDelayIntegerSpecifies 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.
failoverDelayIntegerSpecifies 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.
ghostDemandReportingBooleanFrom v1.3. Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.
handoutLimitIntegerFrom 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.
handoutModeStringSpecifies how IPs are returned when more than one IP is alive and available. Either 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.
healthMaxNumberDefines 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.
healthMultiplierNumberConfigures a cutoff value that's 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 members: 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.
healthThresholdNumberConfigures a cutoff value that's 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.
ipv6BooleanIndicates 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.
lastModifiedStringAn ISO 8601 timestamp that indicates when the property was last changed.
linksArrayA URL path that allows direct navigation to the property.
links[]ObjectLists navigable URLs to resources.
livenessTestsArrayLiveness tests, which run periodically to determine whether your servers respond to requests, as discussed in API concepts.
livenessTests[]ObjectLiveness tests, which run periodically to determine whether your servers respond to requests, as discussed in API concepts.
loadImbalancePercentageNumberIndicates 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.
mapNameStringA 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.
maxUnreachablePenaltyNumberFor 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.
minLiveFractionNumberFrom 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.
mxRecordsArraySpecifies 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.
mxRecords[]ObjectThe object that contains maximum number of records.
name{Hostname}StringThe hostname.
name{apex}StringThe APEX name.
scoreAggregationTypeStringSpecifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Values are mean, median, best, or the default worst.
staticRRSetsArrayFrom v1.4. Contains static recordsets. Use this instead of mxRecords and staticTTL, which are deprecated in version 1.4.
staticRRSets[]ObjectFrom v1.4. TBD.
staticTTLIntegerSpecifies 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.
stickinessBonusConstantIntegerSpecifies 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 members relate to each other, see API concepts.
stickinessBonusPercentageIntegerSpecifies 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 members relate to each other, see API concepts.
trafficTargetsArrayThis specifies where to direct data center traffic. For geographic mapped properties, it's always a cname. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.
trafficTargets[]ObjectThis specifies where to direct data center traffic. For geographic mapped properties, it's always a cname. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.
typeStringSpecifies the load balancing behavior for the property. Either 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 for more information.
unreachableThresholdNumberFor 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.
useComputedTargetsBooleanFor 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.
Domain.properties[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.properties[].livenessTests[]
alternateCACertificatesArrayFrom v1.5. Alternate trust anchors, Base64-encoded CA certificates. Available for livenessTests that use secure protocols.
answersRequiredBooleanFrom 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.
disableNonstandardPortWarningBooleanDisables 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.
disabledBooleanFrom 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.
errorPenaltyNumberFrom 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.
hostHeaderStringSent 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.
httpError3xxBooleanTreats a 3xx HTTP response as a failure if the testObjectProtocol is http, https, or ftp.
httpError4xxBooleanTreats a 4xx HTTP response as a failure if the testObjectProtocol is http, https, or ftp.
httpError5xxBooleanTreats a 5xx HTTP response as a failure if the testObjectProtocol is http, https, or ftp.
httpHeadersArrayFrom v1.4. HTTP headers to send if the testObjectProtocol is http or https. This hostHeader is deprecated as of version 1.4.
httpHeaders[]ObjectFrom v1.4. TBD.
httpMethodStringFrom v1.5. The HTTP method to send if the testObjectProtocol is http or https. Supported values are TRACE, HEAD, OPTIONS, GET, PUT, POST, PATCH, DELETE. When omitted or null, this value defaults to GET.
httpRequestBodyStringFrom 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.
nameStringA descriptive name for the liveness test.
peerCertificateVerificationBooleanFrom v1.3. Validates the origin certificate. Applies only to tests with testObjectProtocol of https. The default is false.
pre2023SecurityPostureBooleanFrom v1.6. Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.
recursionRequestedBooleanFrom v1.3. Indicates that if testObjectProtocol is DNS, DOH or DOT, the DNS query is recursive. The default is false.
requestStringStringSpecifies a request string. Required if testObjectProtocol is tcp or tcps. The value is a maximum of 4000 non-space, alphanumeric characters.
resourceTypeStringFrom v1.3. Specifies the query type, if testObjectProtocol is DNS. Types include: A, AAAA, AFSDB, CNAME, HINFO, LOC, MX, NAPTR, NS, PTR, RP, SOA, SPF, SRV, SSHFP, TXT, DNSKEY, DS, NSEC3, NSEC3PARAM, or RRSIG. Additional support for unknown types TYPENNNNN where NNNNN is an integer from 1 through 65535.
responseStringStringSpecifies a response string. Required if testObjectProtocol is tcp or tcps. Maximum 4000 characters.
sslClientCertificateStringIndicates a Base64-encoded certificate. SSL client certificates are available for livenessTests that use secure protocols.
sslClientPrivateKeyStringIndicates 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.
testIntervalIntegerIndicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.
testObjectStringSpecifies the static text that acts as a stand-in for the data that you're sending on the network.
testObjectPasswordStringSpecifies the test object's password. It's required if testObjectProtocol is ftp. Maximum is 128 characters.
testObjectPortIntegerSpecifies the port number for the testObject. Value from 1 to 65535.
testObjectProtocolStringSpecifies the test protocol. Either 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.
testObjectUsernameStringA 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.
testTimeoutNumberSpecifies the duration of the liveness test before it fails. The range is from 0.001 to 60 seconds.
timeoutPenaltyNumberFrom 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.
Domain.properties[].livenessTests[].httpHeaders[]
nameStringFrom v1.4. Name of the HTTP header.
valueStringFrom v1.4. Value of the HTTP header.
Domain.properties[].mxRecords[]
exchangeStringMX record exchange member.
preferenceNumberMX record preference field.
Domain.properties[].staticRRSets[]
rdataArrayFrom v1.4. 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.
ttlIntegerFrom v1.4. The number of seconds that this record should live in a resolver's cache before being refetched.
typeStringFrom v1.4. The record type.
Domain.properties[].trafficTargets[]
datacenterIdIntegerA unique identifier for an existing data center in the domain.
enabledBooleanIndicates 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.
handoutCNameStringSpecifies 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.
nameStringAn alternative label for the traffic target.
precedenceNumberFrom v1.6. For use by ranked-failover type properties, the lower the number, the higher the precedence.
serversArrayIdentifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.
weightNumberSpecifies 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.
Domain.resources[]
aggregationTypeStringSpecifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Either 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.
constrainedPropertyStringSpecifies the name of the property that this resource constrains, or ** to constrain all properties.
decayRateNumberFor internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.
descriptionStringA descriptive note to help you track what the resource constrains. For example, aggregate bandwidth for all properties. A maximum of 256 characters.
hostHeaderStringOptionally specifies the host header used when fetching the load object.
leaderStringStringSpecifies 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.
leastSquaresDecayNumberFor internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.
linksArraySpecifies the URL path that allows direct navigation to the resource.
links[]ObjectLists navigable URLs to resources.
loadImbalancePercentageNumberIndicates 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.
maxUMultiplicativeIncrementNumberFor internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.
nameStringA descriptive label for the resource. A maximum 150 non-space characters.
resourceInstancesArrayThe resources that constrain the properties within the data center.
resourceInstances[]ObjectTBD.
typeStringIndicates the kind of loadObject format used to determine the load on the resource. Either 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.
upperBoundIntegerAn 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, select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. Learn more.
Domain.resources[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.resources[].resourceInstances[]
datacenterIdIntegerA unique identifier for an existing data center in the domain.
loadObjectStringIdentifies 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.
loadObjectPortIntegerSpecifies 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.
loadServersArraySpecifies 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 addresses.
useDefaultLoadObjectBooleanIndicates whether a default loadObject is used for the resources.
Domain.status
changeIdStringA unique identifier generated when a change occurs to the domain. The maximum length is 36 characters.
linksArraySpecifies the URL path that allows direct navigation to the domain.
links[]ObjectLists navigable URLs to resources.
messageStringA notification generated when a change occurs to the domain. The maximum length is 4000 characters.
passingValidationBooleanIndicates if the domain validates.
propagationStatusStringTracks the status of the domain's propagation state. Either PENDING, COMPLETE, or DENIED. A DENIED value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.
propagationStatusDateStringAn ISO 8601 timestamp indicating when a change occurs to the domain.
Domain.status.links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.

Update domain response


NameTypeDescription
DomainObjectThe basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as example.akadns.net
resourceObjectThe basic building block of a traffic management configuration. Each domain object represents a complete GTM domain such as example.akadns.net.
statusObjectThe 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 operation, which returns information about the current condition of the change in the domain's activation.
Domain.resource
asMapsArrayFrom v1.1. The set of AS maps assigned to this domain.
asMaps[]ObjectFrom v1.1. The AS map configured for the property.
cidrMapsArrayThe set of CIDR maps assigned to this domain.
cidrMaps[]ObjectThe CIDR map configured for the property.
cnameCoalescingEnabledBooleanFrom v1.1. If enabled, GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME. The default value is false.
datacentersArrayThe set of data centers assigned to this domain.
datacenters[]ObjectThe data centers in the GTM domain.
defaultErrorPenaltyIntegerSpecifies 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.
defaultSslClientCertificateStringSpecifies 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 members 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.
defaultSslClientPrivateKeyStringSpecifies 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.
defaultTimeoutPenaltyIntegerSpecifies 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.
deleteRequestIdStringUnique identifier of the request to delete the domain. This ID can be used to track the status or audit the deletion process.
emailNotificationListArrayA list of email addresses to notify when a change is made to the domain.
geographicMapsArrayThe set of geographic maps assigned to this domain.
geographicMaps[]ObjectThe geographic map configured for the property.
lastModifiedStringAn ISO 8601 timestamp that indicates the time of the last domain change.
lastModifiedByStringThe email address of the administrator who made the last change to the domain.
linksArrayA URL path that allows direct navigation to the domain.
links[]ObjectLists navigable URLs to resources.
loadFeedbackBooleanIndicates 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.
loadImbalancePercentageNumberIndicates 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.
modificationCommentsStringA descriptive note about changes to the domain. The maximum is 4000 characters.
nameStringThe full GTM domain name that needs to end in .akadns.net, up to 100 characters.
propertiesArrayThe properties in the GTM domain.
properties[]ObjectThe entire GTM property configuration.
resourcesArrayThe resources in the GTM domain.
resources[]ObjectThe resources in the GTM domain.
signAndServeBooleanFrom v1.5. Whether DNSSEC Sign&Serve is enabled.
signAndServeAlgorithmStringFrom v1.5. The algorithm currently or last used for DNSSEC Sign&Serve. null if no algorithm has ever been assigned to this domain. Either RSA_SHA1, RSA_SHA256, RSA_SHA512, ECDSA_P256_SHA256, ECDSA_P384_SHA384.
statusObjectThe 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 operation, which returns information about the current condition of the change in the domain's activation.
typeStringIndicates the type of domain available based on your contract. Either failover-only, static, weighted, basic, or full.
Domain.resource.asMaps[]
assignmentsArrayFrom v1.1. The AS zone groupings of AS IDs.
assignments[]ObjectFrom v1.1. TBD.
defaultDatacenterObjectFrom v1.1. 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.
linksArrayFrom v1.1. Specifies the URL path that allows direct navigation to the AS map.
links[]ObjectFrom v1.1. Lists navigable URLs to resources.
nameStringFrom v1.1. A descriptive label for the AS map. Properties set up for asmapping can use this as reference.
Domain.resource.asMaps[].assignments[]
asNumbersArrayFrom v1.1. Specifies an array of AS numbers.
datacenterIdIntegerFrom v1.1. A unique identifier for an existing data center in the domain.
nicknameStringFrom v1.1. A descriptive label for the group.
Domain.resource.asMaps[].defaultDatacenter
datacenterIdIntegerFrom v1.1. For each property, an identifier for all other AS zones' CNAME. For example, 5400.
nicknameStringFrom v1.1. A descriptive label for all other AS zones, up to 128 characters. If the value is empty or null, the default is Default Mapping.
Domain.resource.asMaps[].links[]
hrefStringFrom v1.1. Provides a hypermedia link to the complete URL that uniquely defines a resource.
relStringFrom v1.1. Indicates the link relationship of the object.
Domain.resource.cidrMaps[]
assignmentsArrayThe CIDR zone groupings of CIDR blocks.
assignments[]Object
defaultDatacenterObjectA 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.
linksArraySpecifies the URL path that allows direct navigation to the CIDR map.
links[]ObjectLists navigable URLs to resources.
nameStringA descriptive label for the CIDR map, up to 255 characters.
Domain.resource.cidrMaps[].assignments[]
blocksArraySpecifies an array of CIDR blocks.
datacenterIdIntegerA unique identifier for an existing data center in the domain.
nicknameStringA descriptive label for the CIDR zone group, up to 256 characters.
Domain.resource.cidrMaps[].defaultDatacenter
datacenterIdIntegerFor each property, an identifier for all other CIDR zones' CNAME. For example, 5400.
nicknameStringA descriptive label for the all other CIDR blocks. If omitted, the default is All Other CIDR Blocks.
Domain.resource.cidrMaps[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.resource.datacenters[]
cityStringThe name of the city where the data center is located.
cloneOfIntegerIdentifies 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.
cloudServerHostHeaderOverrideBooleanFrom v1.3. Balances load between two or more servers in a cloud environment. Either true if cloud server targeting is enabled or false if not.
cloudServerTargetingBooleanBalances load between two or more servers in a cloud environment. Either true if cloud server targeting is enabled or false if not.
continentStringA two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this data. Either AF, AS, EU, NA, OC, OT, or SA.
countryStringA two-letter ISO 3166 country code that specifies the country where the data center maps to.
datacenterIdIntegerA unique identifier for an existing data center in the domain.
defaultLoadObjectObjectSpecifies 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.
latitudeNumberSpecifies the geographical latitude of the data center's position. See also longitude within this object.
linksArrayA URL path that allows direct navigation to a data center.
links[]ObjectLists navigable URLs to resources.
longitudeNumberSpecifies the geographic longitude of the data center's position. See also latitude within this object.
nicknameStringA descriptive label for the data center.
scorePenaltyIntegerFrom 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.
stateOrProvinceStringSpecifies a two-letter ISO 3166 country code for the state or province where the data center is located.
virtualBooleanIndicates whether or not the data center is virtual or physical, the latter meaning the data center has an Akamai Network Agent installed, and its physical location in latitude and longitude is fixed. Either true if virtual or false if physical.
Domain.resource.datacenters[].defaultLoadObject
loadObjectStringSpecifies 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.
loadObjectPortIntegerSpecifies 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.
loadServersArraySpecifies 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 addresses.
Domain.resource.datacenters[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.resource.geographicMaps[]
assignmentsArrayThe geographic zone groupings of countries.
assignments[]Object
defaultDatacenterObjectA 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.
linksArraySpecifies the URL path that allows direct navigation to the geographic map.
links[]ObjectLists navigable URLs to resources.
nameStringA descriptive label for the geographic map, up to 128 characters.
Domain.resource.geographicMaps[].assignments[]
countriesArraySpecifies 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.
datacenterIdIntegerA unique identifier for an existing data center in the domain.
nicknameStringA descriptive label for the group.
Domain.resource.geographicMaps[].defaultDatacenter
datacenterIdIntegerFor each property, an identifier for all other geographic zones' CNAME. For example, 5400.
nicknameStringA descriptive label for all other geographic zones. The value ranges from 1 to 128 characters. If omitted, defaults to Default Mapping.
Domain.resource.geographicMaps[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.resource.links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.resource.properties[]
backupCNameStringSpecifies 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.
backupIpStringSpecifies 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.
balanceByDownloadScoreBooleanIndicates 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.
cnameStringIndicates the fully qualified name aliased to a particular property. The public name of the property.
commentsStringProvides information about the purpose of the property.
dynamicTTLIntegerIndicates 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.
failbackDelayIntegerSpecifies 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.
failoverDelayIntegerSpecifies 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.
ghostDemandReportingBooleanFrom v1.3. Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content.
handoutLimitIntegerFrom 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.
handoutModeStringSpecifies how IPs are returned when more than one IP is alive and available. Either 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.
healthMaxNumberDefines 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.
healthMultiplierNumberConfigures a cutoff value that's 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 members: 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.
healthThresholdNumberConfigures a cutoff value that's 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.
ipv6BooleanIndicates 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.
lastModifiedStringAn ISO 8601 timestamp that indicates when the property was last changed.
linksArrayA URL path that allows direct navigation to the property.
links[]ObjectLists navigable URLs to resources.
livenessTestsArrayLiveness tests, which run periodically to determine whether your servers respond to requests, as discussed in API concepts.
livenessTests[]ObjectLiveness tests, which run periodically to determine whether your servers respond to requests, as discussed in API concepts.
loadImbalancePercentageNumberIndicates 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.
mapNameStringA 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.
maxUnreachablePenaltyNumberFor 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.
minLiveFractionNumberFrom 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.
mxRecordsArraySpecifies 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.
mxRecords[]Object
name{Hostname}StringThe hostname.
name{apex}StringThe APEX name.
scoreAggregationTypeStringSpecifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Values are mean, median, best, or the default worst.
staticRRSetsArrayFrom v1.4. Contains static recordsets. Use this instead of mxRecords and staticTTL, which are deprecated in version 1.4.
staticRRSets[]ObjectFrom v1.4. TBD.
staticTTLIntegerSpecifies 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.
stickinessBonusConstantIntegerSpecifies 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 members relate to each other, see API concepts.
stickinessBonusPercentageIntegerSpecifies 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 members relate to each other, see API concepts.
trafficTargetsArrayThis specifies where to direct data center traffic. For geographic mapped properties, it's always a cname. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.
trafficTargets[]ObjectThis specifies where to direct data center traffic. For geographic mapped properties, it's always a cname. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.
typeStringSpecifies the load balancing behavior for the property. Either 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 for more information.
unreachableThresholdNumberFor 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.
useComputedTargetsBooleanFor 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.
Domain.resource.properties[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.resource.properties[].livenessTests[]
alternateCACertificatesArrayFrom v1.5. Alternate trust anchors, Base64-encoded CA certificates. Available for livenessTests that use secure protocols.
answersRequiredBooleanFrom 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.
disableNonstandardPortWarningBooleanDisables 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.
disabledBooleanFrom 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.
errorPenaltyNumberFrom 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.
hostHeaderStringSent 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.
httpError3xxBooleanTreats a 3xx HTTP response as a failure if the testObjectProtocol is http, https, or ftp.
httpError4xxBooleanTreats a 4xx HTTP response as a failure if the testObjectProtocol is http, https, or ftp.
httpError5xxBooleanTreats a 5xx HTTP response as a failure if the testObjectProtocol is http, https, or ftp.
httpHeadersArrayFrom v1.4. HTTP headers to send if the testObjectProtocol is http or https. This hostHeader is deprecated as of version 1.4.
httpHeaders[]ObjectFrom v1.4. TBD.
httpMethodStringFrom v1.5. The HTTP method to send if the testObjectProtocol is http or https. Supported values are TRACE, HEAD, OPTIONS, GET, PUT, POST, PATCH, DELETE. When omitted or null, this value defaults to GET.
httpRequestBodyStringFrom 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.
nameStringA descriptive name for the liveness test.
peerCertificateVerificationBooleanFrom v1.3. Validates the origin certificate. Applies only to tests with testObjectProtocol of https. The default is false.
pre2023SecurityPostureBooleanFrom v1.6. Indicates whether the system uses a security posture configuration from before 2023. Defaults to false.
recursionRequestedBooleanFrom v1.3. Indicates that if testObjectProtocol is DNS, DOH or DOT, the DNS query is recursive. The default is false.
requestStringStringSpecifies a request string. Required if testObjectProtocol is tcp or tcps. The value is a maximum of 4000 non-space, alphanumeric characters.
resourceTypeStringFrom v1.3. Specifies the query type, if testObjectProtocol is DNS. Types include: A, AAAA, AFSDB, CNAME, HINFO, LOC, MX, NAPTR, NS, PTR, RP, SOA, SPF, SRV, SSHFP, TXT, DNSKEY, DS, NSEC3, NSEC3PARAM, or RRSIG. Additional support for unknown types TYPENNNNN where NNNNN is an integer from 1 through 65535.
responseStringStringSpecifies a response string. Required if testObjectProtocol is tcp or tcps. Maximum 4000 characters.
sslClientCertificateStringIndicates a Base64-encoded certificate. SSL client certificates are available for livenessTests that use secure protocols.
sslClientPrivateKeyStringIndicates 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.
testIntervalIntegerIndicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds.
testObjectStringSpecifies the static text that acts as a stand-in for the data that you're sending on the network.
testObjectPasswordStringSpecifies the test object's password. It's required if testObjectProtocol is ftp. Maximum is 128 characters.
testObjectPortIntegerSpecifies the port number for the testObject. Value from 1 to 65535.
testObjectProtocolStringSpecifies the test protocol. Either 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.
testObjectUsernameStringA 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.
testTimeoutNumberSpecifies the duration of the liveness test before it fails. The range is from 0.001 to 60 seconds.
timeoutPenaltyNumberFrom 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.
Domain.resource.properties[].livenessTests[].httpHeaders[]
nameStringFrom v1.4. Name of the HTTP header.
valueStringFrom v1.4. Value of the HTTP header.
Domain.resource.properties[].mxRecords[]
exchangeStringMX record exchange member.
preferenceNumberMX record preference field.
Domain.resource.properties[].staticRRSets[]
rdataArrayFrom v1.4. 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.
ttlIntegerFrom v1.4. The number of seconds that this record should live in a resolver's cache before being refetched.
typeStringFrom v1.4. The record type.
Domain.resource.properties[].trafficTargets[]
datacenterIdIntegerA unique identifier for an existing data center in the domain.
enabledBooleanIndicates 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.
handoutCNameStringSpecifies 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.
nameStringAn alternative label for the traffic target.
precedenceNumberFrom v1.6. For use by ranked-failover type properties, the lower the number, the higher the precedence.
serversArrayIdentifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.
weightNumberSpecifies 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.
Domain.resource.resources[]
aggregationTypeStringSpecifies how GTM handles different load numbers when multiple load servers are used for a data center or property. Either 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.
constrainedPropertyStringSpecifies the name of the property that this resource constrains, or ** to constrain all properties.
decayRateNumberFor internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.
descriptionStringA descriptive note to help you track what the resource constrains. For example, aggregate bandwidth for all properties. A maximum of 256 characters.
hostHeaderStringOptionally specifies the host header used when fetching the load object.
leaderStringStringSpecifies 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.
leastSquaresDecayNumberFor internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.
linksArraySpecifies the URL path that allows direct navigation to the resource.
links[]ObjectLists navigable URLs to resources.
loadImbalancePercentageNumberIndicates 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.
maxUMultiplicativeIncrementNumberFor internal use only. Unless Akamai indicates otherwise, omit the value or set it to null.
nameStringA descriptive label for the resource. A maximum 150 non-space characters.
resourceInstancesArrayThe resources that constrain the properties within the data center.
resourceInstances[]Object
typeStringIndicates the kind of loadObject format used to determine the load on the resource. Either 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.
upperBoundIntegerAn 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, select Alerts from the Common Services category, then create a Load Object File Invalid or Cannot be Fetched alert. Learn more.
Domain.resource.resources[].links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.resource.resources[].resourceInstances[]
datacenterIdIntegerA unique identifier for an existing data center in the domain.
loadObjectStringIdentifies 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.
loadObjectPortIntegerSpecifies 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.
loadServersArraySpecifies 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 addresses.
useDefaultLoadObjectBooleanIndicates whether a default loadObject is used for the resources.
Domain.resource.status
changeIdStringA unique identifier generated when a change occurs to the domain. The maximum length is 36 characters.
linksArraySpecifies the URL path that allows direct navigation to the domain.
links[]ObjectLists navigable URLs to resources.
messageStringA notification generated when a change occurs to the domain. The maximum length is 4000 characters.
passingValidationBooleanIndicates if the domain validates.
propagationStatusStringTracks the status of the domain's propagation state. Either PENDING, COMPLETE, or DENIED. A DENIED value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.
propagationStatusDateStringAn ISO 8601 timestamp indicating when a change occurs to the domain.
Domain.resource.status.links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Domain.status
changeIdStringA unique identifier generated when a change occurs to the domain. The maximum length is 36 characters.
linksArraySpecifies the URL path that allows direct navigation to the domain.
links[]ObjectLists navigable URLs to resources.
messageStringA notification generated when a change occurs to the domain. The maximum length is 4000 characters.
passingValidationBooleanIndicates if the domain validates.
propagationStatusStringTracks the status of the domain's propagation state. Either PENDING, COMPLETE, or DENIED. A DENIED value indicates that the domain configuration is invalid, and doesn't propagate until the validation errors are resolved.
propagationStatusDateStringAn ISO 8601 timestamp indicating when a change occurs to the domain.
Domain.status.links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.