Liveness tests, which run periodically to determine whether your servers respond to requests, as discussed in API concepts.
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.
domainName
String
Pre-v1.0. The full GTM domain name.
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.
result
String
Pre-v1.0. Liveness Test results.
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.
