Datacenter

NameTypeDescription
DatacenterObjectThe data centers in the GTM domain.
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[]ObjectFrom v1.1. Lists 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.
Datacenter.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.
Datacenter.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.

Update Datacenter response


NameTypeDescription
DatacenterObjectThe data centers in the GTM domain.
resourceObjectThe data centers in the GTM domain.
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.
Datacenter.resource
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.
Datacenter.resource.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.
Datacenter.resource.links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.
Datacenter.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.
Datacenter.status.links[]
hrefStringProvides a hypermedia link to the complete URL that uniquely defines a resource.
relStringIndicates the link relationship of the object.