config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api
config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
Option 3
\nobject
The subtest step used in a Synthetics multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
alwaysExecute
\nboolean
A boolean set to always execute this step even if the previous step failed or was skipped.
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtestPublicId [required]
\nstring
Public ID of the test to be played as part of a playSubTest step type.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API subtest step. \nAllowed enum values: playSubTest
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api
config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api
config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
Option 3
\nobject
The subtest step used in a Synthetics multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
alwaysExecute
\nboolean
A boolean set to always execute this step even if the previous step failed or was skipped.
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtestPublicId [required]
\nstring
Public ID of the test to be played as part of a playSubTest step type.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API subtest step. \nAllowed enum values: playSubTest
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api
config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api
config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
Option 3
\nobject
The subtest step used in a Synthetics multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
alwaysExecute
\nboolean
A boolean set to always execute this step even if the previous step failed or was skipped.
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtestPublicId [required]
\nstring
Public ID of the test to be played as part of a playSubTest step type.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API subtest step. \nAllowed enum values: playSubTest
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api
config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api
config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
Option 3
\nobject
The subtest step used in a Synthetics multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
alwaysExecute
\nboolean
A boolean set to always execute this step even if the previous step failed or was skipped.
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtestPublicId [required]
\nstring
Public ID of the test to be played as part of a playSubTest step type.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API subtest step. \nAllowed enum values: playSubTest
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api
config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api
config [required]
\nobject
Configuration object for a Synthetic API test.
assertions
\n[ <oneOf>]
Array of assertions used for the test. Required for single API tests.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
configVariables
\n[object]
Array of variables used for the test.
example
\nstring
Example for the variable.
id
\nstring
ID of the variable for global variables.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]
\nenum
Type of the configuration variable. \nAllowed enum values: global,text,email
request
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
steps
\n[ <oneOf>]
When the test subtype is multi, the steps of the test.
Option 1
\nobject
The Test step used in a Synthetic multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
assertions [required]
\n[ <oneOf>]
Array of assertions used for the test.
default:
Option 1
\nobject
An assertion which uses a simple target.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined
property
\nstring
The associated assertion property.
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
timingsScope
\nenum
Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 2
\nobject
An assertion which targets body hash.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256
target [required]
\n<oneOf>
Value used by the operator.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: bodyHash
Option 3
\nobject
An assertion for the validatesJSONPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesJSONPath operator.
elementsOperator
\nstring
The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.
jsonPath
\nstring
The JSON path to assert.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 4
\nobject
An assertion for the validatesJSONSchema operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesJSONSchema
target
\nobject
Composed target for validatesJSONSchema operator.
jsonSchema
\nstring
The JSON Schema to assert.
metaSchema
\nenum
The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 5
\nobject
An assertion for the validatesXPath operator.
operator [required]
\nenum
Assertion operator to apply. \nAllowed enum values: validatesXPath
property
\nstring
The associated assertion property.
target
\nobject
Composed target for validatesXPath operator.
operator
\nstring
The specific operator to use on the path.
targetValue
\n<oneOf>
The path target value to compare to.
Option 1
\ndouble
Numeric value used by the operator in assertions.
Option 2
\nstring
String value used by the operator in assertions. Supports templated variables.
xPath
\nstring
The X path to assert.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection
Option 6
\nobject
A JavaScript assertion.
code [required]
\nstring
The JavaScript code that performs the assertions.
type [required]
\nenum
Type of the assertion. \nAllowed enum values: javascript
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header or grpc_metadata, name of the header or metadatum to extract.
name
\nstring
Name of the variable to extract.
parser
\nobject
Details of the parser to use for the global variable.
type [required]
\nenum
Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path
value
\nstring
Regex or JSON path used for the parser. Not used with type raw.
secure
\nboolean
Determines whether or not the extracted value will be obfuscated.
type
\nenum
Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
request [required]
\nobject
Object describing the Synthetic test request.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth
\n<oneOf>
Object to handle basic authentication when performing the test.
Option 1
\nobject
Object to handle basic authentication when performing the test.
password
\nstring
Password to use for the basic authentication.
type
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: web
default: web
username
\nstring
Username to use for the basic authentication.
Option 2
\nobject
Object to handle SIGV4 authentication when performing the test.
accessKey [required]
\nstring
Access key for the SIGV4 authentication.
region
\nstring
Region for the SIGV4 authentication.
secretKey [required]
\nstring
Secret key for the SIGV4 authentication.
serviceName
\nstring
Service name for the SIGV4 authentication.
sessionToken
\nstring
Session token for the SIGV4 authentication.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: sigv4
default: sigv4
Option 3
\nobject
Object to handle NTLM authentication when performing the test.
domain
\nstring
Domain for the authentication to use when performing the test.
password
\nstring
Password for the authentication to use when performing the test.
type [required]
\nenum
The type of authentication to use when performing the test. \nAllowed enum values: ntlm
default: ntlm
username
\nstring
Username for the authentication to use when performing the test.
workstation
\nstring
Workstation for the authentication to use when performing the test.
Option 4
\nobject
Object to handle digest authentication when performing the test.
password [required]
\nstring
Password to use for the digest authentication.
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: digest
default: digest
username [required]
\nstring
Username to use for the digest authentication.
Option 5
\nobject
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId [required]
\nstring
Client ID to use when performing the authentication.
clientSecret [required]
\nstring
Client secret to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client
default: oauth-client
Option 6
\nobject
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]
\nstring
Access token URL to use when performing the authentication.
audience
\nstring
Audience to use when performing the authentication.
clientId
\nstring
Client ID to use when performing the authentication.
clientSecret
\nstring
Client secret to use when performing the authentication.
password [required]
\nstring
Password to use when performing the authentication.
resource
\nstring
Resource to use when performing the authentication.
scope
\nstring
Scope to use when performing the authentication.
tokenApiAuthentication [required]
\nenum
Type of token to use when performing the authentication. \nAllowed enum values: header,body
type [required]
\nenum
The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop
default: oauth-rop
username [required]
\nstring
Username to use when performing the authentication.
body
\nstring
Body to include in the test.
bodyType
\nenum
Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data
callType
\nenum
The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary
certificate
\nobject
Client certificate to use when performing the test request.
cert
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
key
\nobject
Define a request certificate.
content
\nstring
Content of the certificate or key.
filename
\nstring
File name for the certificate or key.
updatedAt
\nstring
Date of update of the certificate or key, ISO format.
certificateDomains
\n[string]
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.
default:
checkCertificateRevocation
\nboolean
Check for certificate revocation.
compressedJsonDescriptor
\nstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFile
\nstring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetching
\nboolean
Disable fetching intermediate certificates from AIA.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\n<oneOf>
DNS server port to use for DNS tests.
Option 1
\nint64
Integer DNS server port number to use when performing the test.
Option 2
\nstring
String DNS server port number to use when performing the test. Supports templated variables.
files
\n[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKey
\nstring
Bucket key of the file.
content
\nstring
Content of the file.
name
\nstring
Name of the file.
originalFileName
\nstring
Original name of the file.
size
\nint64
Size of the file.
type
\nstring
Type of the file.
follow_redirects
\nboolean
Specifies whether or not the request follows redirects.
form
\nobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>
\nstring
A single form entry.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
host
\nstring
Host name to perform the test with.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
isMessageBase64Encoded
\nboolean
Whether the message is base64 encoded.
message
\nstring
Message to send for UDP or WebSocket tests.
metadata
\nobject
Metadata to include when performing the gRPC test.
<any-key>
\nstring
A single metadatum.
method
\nstring
Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.
noSavingResponseBody
\nboolean
Determines whether or not to save the response body.
numberOfPackets
\nint32
Number of pings to use per test.
persistCookies
\nboolean
Persist cookies across redirects.
port
\n<oneOf>
Port to use when performing the test.
Option 1
\nint64
Integer Port number to use when performing the test.
Option 2
\nstring
String Port number to use when performing the test. Supports templated variables.
proxy
\nobject
The proxy to perform the test.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
url [required]
\nstring
URL of the proxy to perform the test.
query
\nobject
Query to use for the test.
servername
\nstring
For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.
service
\nstring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHops
\nboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeout
\ndouble
Timeout in seconds for the test.
url
\nstring
URL to perform the test with.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc,ssl,dns,tcp,udp,icmp,websocket
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
id
\nstring
ID of the step.
name [required]
\nstring
The name of the step.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait
value [required]
\nint32
The time to wait in seconds. Minimum value: 0. Maximum value: 180.
Option 3
\nobject
The subtest step used in a Synthetics multi-step API test.
allowFailure
\nboolean
Determines whether or not to continue with test if this step fails.
alwaysExecute
\nboolean
A boolean set to always execute this step even if the previous step failed or was skipped.
exitIfSucceed
\nboolean
Determines whether or not to exit the test if the step succeeds.
extractedValuesFromScript
\nstring
Generate variables using JavaScript.
id
\nstring
ID of the step.
isCritical
\nboolean
Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.
name [required]
\nstring
The name of the step.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
subtestPublicId [required]
\nstring
Public ID of the test to be played as part of a playSubTest step type.
subtype [required]
\nenum
The subtype of the Synthetic multi-step API subtest step. \nAllowed enum values: playSubTest
variablesFromScript
\nstring
Variables defined from JavaScript code.
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name [required]
\nstring
Name of the test.
options [required]
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL tests, whether or not the test should allow self signed\ncertificates.
allow_insecure
\nboolean
Allows loading insecure content for an HTTP request in an API test.
blockedRequestPatterns
\n[string]
Array of URL patterns to block.
checkCertificateRevocation
\nboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule [required]
\nenum
Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped
device_ids
\n[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetching
\nboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCors
\nboolean
Whether or not to disable CORS mechanism.
disableCsp
\nboolean
Disable Content Security Policy for browser tests.
enableProfiling
\nboolean
Enable profiling for browser tests.
enableSecurityTesting
\nboolean
DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersion
\nenum
HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any
ignoreServerCertificateError
\nboolean
Ignore server certificate error for browser tests.
initialNavigationTimeout
\nint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_duration
\nint64
Minimum amount of time in failure required to trigger an alert.
min_location_failed
\nint64
Minimum number of locations in failure required to trigger\nan alert.
monitor_name
\nstring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_options
\nobject
Object containing the options for a Synthetic test as a monitor\n(for example, renotification).
escalation_message
\nstring
Message to include in the escalation notification.
notification_preset_name
\nenum
The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
renotify_occurrences
\nint64
The number of times to renotify if the test is still failing.
monitor_priority
\nint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshot
\nboolean
Prevents saving screenshots of the steps.
restricted_roles
\n[string]
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
retry
\nobject
Object describing the retry strategy to apply to a Synthetic test.
count
\nint64
Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.
interval
\ndouble
Time interval between retries (in milliseconds). Defaults to\n300ms.
rumSettings
\nobject
The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:
\n{ isEnabled: false }\nRUM data is not collected.
{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.
applicationId
\nstring
RUM application ID used to collect RUM data for the browser test.
clientTokenId
\nint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]
\nboolean
Determines whether RUM data is collected during test runs.
scheduling
\nobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required]
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]
\nint32
Number representing the day of the week.
from [required]
\nstring
The hour of the day on which scheduling starts.
to [required]
\nstring
The hour of the day on which scheduling ends.
timezone [required]
\nstring
Timezone in which the timeframe is based.
tick_every
\nint64
The frequency at which to run the Synthetic test (in seconds).
public_id
\nstring
The public ID for the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
subtype
\nenum
The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, api. \nAllowed enum values: api
default: api