Name | Type | Description |
---|---|---|
Property | Object | The entire GTM property configuration. |
backupCName | String | 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 . |
backupIp | String | 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 . |
balanceByDownloadScore | Boolean | 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. |
cname | String | Indicates the fully qualified name aliased to a particular property. The public name of the property. |
comments | String | Provides information about the purpose of the property. |
dynamicTTL | Integer | 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 . |
failbackDelay | Integer | 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. |
failoverDelay | Integer | 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. |
ghostDemandReporting | Boolean | From v1.3. Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content. |
handoutLimit | Integer | From 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. |
handoutMode | String | Specifies 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. |
healthMax | Number | 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 . |
healthMultiplier | Number | Configures a cutoff value that's 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. |
healthThreshold | Number | Configures a cutoff value that's 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. |
ipv6 | Boolean | 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. |
lastModified | String | An ISO 8601 timestamp that indicates when the property was last changed. |
links | Array | A URL path that allows direct navigation to the property. |
links[] | Object | Lists navigable URLs to resources. |
livenessTests | Array | Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in API concepts. |
livenessTests[] | Object | Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in API concepts. |
loadImbalancePercentage | Number | 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. |
mapName | String | 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. |
maxUnreachablePenalty | Number | 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. |
minLiveFraction | Number | From 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 . |
mxRecords | Array | 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. |
mxRecords[] | Object | |
name{Hostname} | String | The hostname. |
name{apex} | String | The APEX name. |
scoreAggregationType | String | Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Values are mean , median , best , or the default worst . |
staticRRSets | Array | From v1.4. Contains static recordsets. Use this instead of mxRecords and staticTTL , which are deprecated in version 1.4. |
staticRRSets[] | Object | From v1.4. TBD. |
staticTTL | Integer | 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. |
stickinessBonusConstant | Integer | 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 members relate to each other, see API concepts. |
stickinessBonusPercentage | Integer | 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 members relate to each other, see API concepts. |
trafficTargets | Array | This specifies where to direct data center traffic. For geographic mapped properties, it's always a cname . For mirror failover properties, it can be any set of servers. For load balanced properties, this 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[] | Object | This specifies where to direct data center traffic. For geographic mapped properties, it's always a cname . For mirror failover properties, it can be any set of servers. For load balanced properties, this 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 | String | Specifies 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. |
unreachableThreshold | Number | 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. |
useComputedTargets | Boolean | 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. |
Property.links[] | ||
href | String | Provides a hypermedia link to the complete URL that uniquely defines a resource. |
rel | String | Indicates the link relationship of the object. |
Property.livenessTests[] | ||
alternateCACertificates | Array | From v1.5. Alternate trust anchors, Base64-encoded CA certificates. Available for livenessTests that use secure protocols. |
answersRequired | Boolean | From 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 . |
disableNonstandardPortWarning | Boolean | 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 . |
disabled | Boolean | From 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 . |
errorPenalty | Number | From 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 . |
hostHeader | String | 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. |
httpError3xx | Boolean | Treats a 3xx HTTP response as a failure if the testObjectProtocol is http , https , or ftp . |
httpError4xx | Boolean | Treats a 4xx HTTP response as a failure if the testObjectProtocol is http , https , or ftp . |
httpError5xx | Boolean | Treats a 5xx HTTP response as a failure if the testObjectProtocol is http , https , or ftp . |
httpHeaders | Array | From v1.4. HTTP headers to send if the testObjectProtocol is http or https . This hostHeader is deprecated as of version 1.4. |
httpHeaders[] | Object | From v1.4. TBD. |
httpMethod | String | From 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 . |
httpRequestBody | String | From 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. |
name | String | A descriptive name for the liveness test. |
peerCertificateVerification | Boolean | From v1.3. Validates the origin certificate. Applies only to tests with testObjectProtocol of https . The default is false . |
pre2023SecurityPosture | Boolean | From v1.6. Indicates whether the system uses a security posture configuration from before 2023. Defaults to false. |
recursionRequested | Boolean | From v1.3. Indicates that if testObjectProtocol is DNS , DOH or DOT , the DNS query is recursive. The default is false . |
requestString | String | Specifies a request string. Required if testObjectProtocol is tcp or tcps . The value is a maximum of 4000 non-space, alphanumeric characters. |
resourceType | String | From 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 . |
responseString | String | Specifies a response string. Required if testObjectProtocol is tcp or tcps . Maximum 4000 characters. |
sslClientCertificate | String | Indicates a Base64-encoded certificate. SSL client certificates are available for livenessTests that use secure protocols. |
sslClientPrivateKey | String | 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. |
testInterval | Integer | Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds. |
testObject | String | Specifies the static text that acts as a stand-in for the data that you're sending on the network. |
testObjectPassword | String | Specifies the test object's password. It's required if testObjectProtocol is ftp . Maximum is 128 characters. |
testObjectPort | Integer | Specifies the port number for the testObject . Value from 1 to 65535 . |
testObjectProtocol | String | Specifies 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 . |
testObjectUsername | String | 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. |
testTimeout | Number | Specifies the duration of the liveness test before it fails. The range is from 0.001 to 60 seconds. |
timeoutPenalty | Number | From 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. |
Property.livenessTests[].httpHeaders[] | ||
name | String | From v1.4. Name of the HTTP header. |
value | String | From v1.4. Value of the HTTP header. |
Property.mxRecords[] | ||
exchange | String | MX record exchange member. |
preference | Number | MX record preference field. |
Property.staticRRSets[] | ||
rdata | Array | From 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. |
ttl | Integer | From v1.4. The number of seconds that this record should live in a resolver's cache before being refetched. |
type | String | From v1.4. The record type. |
Property.trafficTargets[] | ||
datacenterId | Integer | A unique identifier for an existing data center in the domain. |
enabled | Boolean | 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. |
handoutCName | String | 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. |
name | String | An alternative label for the traffic target. |
precedence | Number | From v1.6. For use by ranked-failover type properties, the lower the number, the higher the precedence. |
servers | Array | Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness. |
weight | Number | 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. |
Update property response
Name | Type | Description |
---|---|---|
Property | Object | The entire GTM property configuration. |
resource | Object | The resource of the property. |
status | Object | 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 operation, which returns information about the current condition of the change in the domain's activation. |
Property.resource | ||
backupCName | String | 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 . |
backupIp | String | 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 . |
balanceByDownloadScore | Boolean | 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. |
cname | String | Indicates the fully qualified name aliased to a particular property. The public name of the property. |
comments | String | Provides information about the purpose of the property. |
dynamicTTL | Integer | 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 . |
failbackDelay | Integer | 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. |
failoverDelay | Integer | 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. |
ghostDemandReporting | Boolean | From v1.3. Enables reporting of unmet content requests received by edge servers, analyzing demand for unserved content. |
handoutLimit | Integer | From 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. |
handoutMode | String | Specifies 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. |
healthMax | Number | 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 . |
healthMultiplier | Number | Configures a cutoff value that's 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. |
healthThreshold | Number | Configures a cutoff value that's 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. |
ipv6 | Boolean | 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. |
lastModified | String | An ISO 8601 timestamp that indicates when the property was last changed. |
links | Array | A URL path that allows direct navigation to the property. |
links[] | Object | Lists navigable URLs to resources. |
livenessTests | Array | Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in API concepts. |
livenessTests[] | Object | Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in API concepts. |
loadImbalancePercentage | Number | 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. |
mapName | String | 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. |
maxUnreachablePenalty | Number | 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. |
minLiveFraction | Number | From 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 . |
mxRecords | Array | 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. |
mxRecords[] | Object | |
name{Hostname} | String | The hostname. |
name{apex} | String | The APEX name. |
scoreAggregationType | String | Specifies how GTM aggregates liveness test scores across different tests, when multiple tests are configured. Values are mean , median , best , or the default worst . |
staticRRSets | Array | From v1.4. Contains static recordsets. Use this instead of mxRecords and staticTTL , which are deprecated in version 1.4. |
staticRRSets[] | Object | From v1.4. TBD. |
staticTTL | Integer | 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. |
stickinessBonusConstant | Integer | 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 members relate to each other, see API concepts. |
stickinessBonusPercentage | Integer | 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 members relate to each other, see API concepts. |
trafficTargets | Array | This specifies where to direct data center traffic. For geographic mapped properties, it's always a cname . For mirror failover properties, it can be any set of servers. For load balanced properties, this 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[] | Object | This specifies where to direct data center traffic. For geographic mapped properties, it's always a cname . For mirror failover properties, it can be any set of servers. For load balanced properties, this 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 | String | Specifies 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. |
unreachableThreshold | Number | 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. |
useComputedTargets | Boolean | 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. |
Property.resource.links[] | ||
href | String | Provides a hypermedia link to the complete URL that uniquely defines a resource. |
rel | String | Indicates the link relationship of the object. |
Property.resource.livenessTests[] | ||
alternateCACertificates | Array | From v1.5. Alternate trust anchors, Base64-encoded CA certificates. Available for livenessTests that use secure protocols. |
answersRequired | Boolean | From 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 . |
disableNonstandardPortWarning | Boolean | 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 . |
disabled | Boolean | From 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 . |
errorPenalty | Number | From 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 . |
hostHeader | String | 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. |
httpError3xx | Boolean | Treats a 3xx HTTP response as a failure if the testObjectProtocol is http , https , or ftp . |
httpError4xx | Boolean | Treats a 4xx HTTP response as a failure if the testObjectProtocol is http , https , or ftp . |
httpError5xx | Boolean | Treats a 5xx HTTP response as a failure if the testObjectProtocol is http , https , or ftp . |
httpHeaders | Array | From v1.4. HTTP headers to send if the testObjectProtocol is http or https . This hostHeader is deprecated as of version 1.4. |
httpHeaders[] | Object | From v1.4. TBD. |
httpMethod | String | From 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 . |
httpRequestBody | String | From 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. |
name | String | A descriptive name for the liveness test. |
peerCertificateVerification | Boolean | From v1.3. Validates the origin certificate. Applies only to tests with testObjectProtocol of https . The default is false . |
pre2023SecurityPosture | Boolean | From v1.6. Indicates whether the system uses a security posture configuration from before 2023. Defaults to false. |
recursionRequested | Boolean | From v1.3. Indicates that if testObjectProtocol is DNS , DOH or DOT , the DNS query is recursive. The default is false . |
requestString | String | Specifies a request string. Required if testObjectProtocol is tcp or tcps . The value is a maximum of 4000 non-space, alphanumeric characters. |
resourceType | String | From 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 . |
responseString | String | Specifies a response string. Required if testObjectProtocol is tcp or tcps . Maximum 4000 characters. |
sslClientCertificate | String | Indicates a Base64-encoded certificate. SSL client certificates are available for livenessTests that use secure protocols. |
sslClientPrivateKey | String | 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. |
testInterval | Integer | Indicates the interval at which the liveness test is run, in seconds. Requires a minimum of 10 seconds. |
testObject | String | Specifies the static text that acts as a stand-in for the data that you're sending on the network. |
testObjectPassword | String | Specifies the test object's password. It's required if testObjectProtocol is ftp . Maximum is 128 characters. |
testObjectPort | Integer | Specifies the port number for the testObject . Value from 1 to 65535 . |
testObjectProtocol | String | Specifies 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 . |
testObjectUsername | String | 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. |
testTimeout | Number | Specifies the duration of the liveness test before it fails. The range is from 0.001 to 60 seconds. |
timeoutPenalty | Number | From 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. |
Property.resource.livenessTests[].httpHeaders[] | ||
name | String | From v1.4. Name of the HTTP header. |
value | String | From v1.4. Value of the HTTP header. |
Property.resource.mxRecords[] | ||
exchange | String | MX record exchange member. |
preference | Number | MX record preference field. |
Property.resource.staticRRSets[] | ||
rdata | Array | From 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. |
ttl | Integer | From v1.4. The number of seconds that this record should live in a resolver's cache before being refetched. |
type | String | From v1.4. The record type. |
Property.resource.trafficTargets[] | ||
datacenterId | Integer | A unique identifier for an existing data center in the domain. |
enabled | Boolean | 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. |
handoutCName | String | 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. |
name | String | An alternative label for the traffic target. |
precedence | Number | From v1.6. For use by ranked-failover type properties, the lower the number, the higher the precedence. |
servers | Array | Identifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness. |
weight | Number | 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. |
Property.status | ||
changeId | String | A unique identifier generated when a change occurs to the domain. The maximum length is 36 characters. |
links | Array | Specifies the URL path that allows direct navigation to the domain. |
links[] | Object | Lists navigable URLs to resources. |
message | String | A notification generated when a change occurs to the domain. The maximum length is 4000 characters. |
passingValidation | Boolean | Indicates if the domain validates. |
propagationStatus | String | Tracks 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. |
propagationStatusDate | String | An ISO 8601 timestamp indicating when a change occurs to the domain. |
Property.status.links[] | ||
href | String | Provides a hypermedia link to the complete URL that uniquely defines a resource. |
rel | String | Indicates the link relationship of the object. |