tests
\n[object]
Array of Synthetic tests configuration.
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
tests
\n[object]
Array of Synthetic tests configuration.
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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[object <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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
extractedValues
\n[object]
Array of values to parse and save as variables from the response.
field
\nstring
When type is http_header, name of the header to use to extract the value.
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 use for a Synthetic global variable. \nAllowed enum values: http_body,http_header,local_variable
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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
Option 2
\nobject
The Wait step used in a Synthetic multi-step API test.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
config [required]
\nobject
Configuration object for a Synthetic browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
config [required]
\nobject
Configuration object for a Synthetic browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
config [required]
\nobject
Configuration object for a Synthetic browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
config [required]
\nobject
Configuration object for a Synthetic browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
config [required]
\nobject
Configuration object for a Synthetic browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
config [required]
\nobject
Configuration object for a Synthetic browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
config [required]
\nobject
Configuration object for a Synthetic browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
config [required]
\nobject
Configuration object for a Synthetic browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
config [required]
\nobject
Configuration object for a Synthetic browser test.
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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
locations [required]
\n[string]
Array of locations used to run the test.
message [required]
\nstring
Notification message associated with the test. Message can either be text or an empty string.
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 test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 of the test.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
Array of steps for the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
tags
\n[string]
Array of tags attached to the test.
type [required]
\nenum
Type of the Synthetic test, browser. \nAllowed enum values: browser
default: browser
check
\nobject
Object describing the browser test configuration.
config [required]
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
check_time
\ndouble
When the browser test was conducted.
check_version
\nint64
Version of the browser test used.
probe_dc
\nstring
Location from which the browser test was performed.
result
\nobject
Object containing results for your Synthetic browser test.
browserType
\nstring
Type of browser device used for the browser test.
browserVersion
\nstring
Browser version used for the browser test.
device
\nobject
Object describing the device used to perform the Synthetic test.
height [required]
\nint64
Screen height of the device.
id [required]
\nenum
The device ID. \nAllowed enum values: laptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small
isMobile
\nboolean
Whether or not the device is a mobile.
name [required]
\nstring
The device name.
width [required]
\nint64
Screen width of the device.
duration
\ndouble
Global duration in second of the browser test.
error
\nstring
Error returned for the browser test.
failure
\nobject
The browser test failure details.
code
\nenum
Error code that can be returned by a Synthetic test. \nAllowed enum values: API_REQUEST_FAILURE,ASSERTION_FAILURE,DOWNLOAD_FILE_TOO_LARGE,ELEMENT_NOT_INTERACTABLE,EMAIL_VARIABLE_NOT_DEFINED,EVALUATE_JAVASCRIPT,EVALUATE_JAVASCRIPT_CONTEXT,EXTRACT_VARIABLE,FORBIDDEN_URL,FRAME_DETACHED,INCONSISTENCIES,INTERNAL_ERROR,INVALID_TYPE_TEXT_DELAY,INVALID_URL,INVALID_VARIABLE_PATTERN,INVISIBLE_ELEMENT,LOCATE_ELEMENT,NAVIGATE_TO_LINK,OPEN_URL,PRESS_KEY,SERVER_CERTIFICATE,SELECT_OPTION,STEP_TIMEOUT,SUB_TEST_NOT_PASSED,TEST_TIMEOUT,TOO_MANY_HTTP_REQUESTS,UNAVAILABLE_BROWSER,UNKNOWN,UNSUPPORTED_AUTH_SCHEMA,UPLOAD_FILES_ELEMENT_TYPE,UPLOAD_FILES_DIALOG,UPLOAD_FILES_DYNAMIC_ELEMENT,UPLOAD_FILES_NAME
message
\nstring
The browser test error message.
passed
\nboolean
Whether or not the browser test was conducted.
receivedEmailCount
\nint64
The amount of email received during the browser test.
startUrl
\nstring
Starting URL for the browser test.
stepDetails
\n[object]
Array containing the different browser test steps.
browserErrors
\n[object]
Array of errors collected for a browser test.
description [required]
\nstring
Description of the error.
name [required]
\nstring
Name of the error.
status
\nint64
Status Code of the error.
type [required]
\nenum
Error type returned by a browser test. \nAllowed enum values: network,js
checkType
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
description
\nstring
Description of the test.
duration
\ndouble
Total duration in millisecond of the test.
error
\nstring
Error returned by the test.
playingTab
\nenum
Navigate between different tabs for your browser test. \nAllowed enum values: -1,0,1,2,3
screenshotBucketKey
\nboolean
Whether or not screenshots where collected by the test.
skipped
\nboolean
Whether or not to skip this step.
snapshotBucketKey
\nboolean
Whether or not snapshots where collected by the test.
stepId
\nint64
The step ID.
subTestStepDetails
\n[object]
If this step includes a sub-test.\nSubtests documentation.
timeToInteractive
\ndouble
Time before starting the step.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
url
\nstring
URL to perform the step against.
value
\nValue for the step.
vitalsMetrics
\n[object]
Array of Core Web Vitals metrics for the step.
cls
\ndouble
Cumulative Layout Shift.
lcp
\ndouble
Largest Contentful Paint in milliseconds.
url
\nstring
URL attached to the metrics.
warnings
\n[object]
Warning collected that didn't failed the step.
message [required]
\nstring
Message for the warning.
type [required]
\nenum
User locator used. \nAllowed enum values: user_locator
thumbnailsBucketKey
\nboolean
Whether or not a thumbnail is associated with the browser test.
timeToInteractive
\ndouble
Time in second to wait before the browser test starts after\nreaching the start URL.
result_id
\nstring
ID of the browser test result.
status
\nenum
The status of your Synthetic monitor.
\nO for not triggered1 for triggered2 for no data \nAllowed enum values: 0,1,2check
\nobject
Object describing the browser test configuration.
config [required]
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
check_time
\ndouble
When the browser test was conducted.
check_version
\nint64
Version of the browser test used.
probe_dc
\nstring
Location from which the browser test was performed.
result
\nobject
Object containing results for your Synthetic browser test.
browserType
\nstring
Type of browser device used for the browser test.
browserVersion
\nstring
Browser version used for the browser test.
device
\nobject
Object describing the device used to perform the Synthetic test.
height [required]
\nint64
Screen height of the device.
id [required]
\nenum
The device ID. \nAllowed enum values: laptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small
isMobile
\nboolean
Whether or not the device is a mobile.
name [required]
\nstring
The device name.
width [required]
\nint64
Screen width of the device.
duration
\ndouble
Global duration in second of the browser test.
error
\nstring
Error returned for the browser test.
failure
\nobject
The browser test failure details.
code
\nenum
Error code that can be returned by a Synthetic test. \nAllowed enum values: API_REQUEST_FAILURE,ASSERTION_FAILURE,DOWNLOAD_FILE_TOO_LARGE,ELEMENT_NOT_INTERACTABLE,EMAIL_VARIABLE_NOT_DEFINED,EVALUATE_JAVASCRIPT,EVALUATE_JAVASCRIPT_CONTEXT,EXTRACT_VARIABLE,FORBIDDEN_URL,FRAME_DETACHED,INCONSISTENCIES,INTERNAL_ERROR,INVALID_TYPE_TEXT_DELAY,INVALID_URL,INVALID_VARIABLE_PATTERN,INVISIBLE_ELEMENT,LOCATE_ELEMENT,NAVIGATE_TO_LINK,OPEN_URL,PRESS_KEY,SERVER_CERTIFICATE,SELECT_OPTION,STEP_TIMEOUT,SUB_TEST_NOT_PASSED,TEST_TIMEOUT,TOO_MANY_HTTP_REQUESTS,UNAVAILABLE_BROWSER,UNKNOWN,UNSUPPORTED_AUTH_SCHEMA,UPLOAD_FILES_ELEMENT_TYPE,UPLOAD_FILES_DIALOG,UPLOAD_FILES_DYNAMIC_ELEMENT,UPLOAD_FILES_NAME
message
\nstring
The browser test error message.
passed
\nboolean
Whether or not the browser test was conducted.
receivedEmailCount
\nint64
The amount of email received during the browser test.
startUrl
\nstring
Starting URL for the browser test.
stepDetails
\n[object]
Array containing the different browser test steps.
browserErrors
\n[object]
Array of errors collected for a browser test.
description [required]
\nstring
Description of the error.
name [required]
\nstring
Name of the error.
status
\nint64
Status Code of the error.
type [required]
\nenum
Error type returned by a browser test. \nAllowed enum values: network,js
checkType
\nenum
Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty
description
\nstring
Description of the test.
duration
\ndouble
Total duration in millisecond of the test.
error
\nstring
Error returned by the test.
playingTab
\nenum
Navigate between different tabs for your browser test. \nAllowed enum values: -1,0,1,2,3
screenshotBucketKey
\nboolean
Whether or not screenshots where collected by the test.
skipped
\nboolean
Whether or not to skip this step.
snapshotBucketKey
\nboolean
Whether or not snapshots where collected by the test.
stepId
\nint64
The step ID.
subTestStepDetails
\n[object]
If this step includes a sub-test.\nSubtests documentation.
timeToInteractive
\ndouble
Time before starting the step.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
url
\nstring
URL to perform the step against.
value
\nValue for the step.
vitalsMetrics
\n[object]
Array of Core Web Vitals metrics for the step.
cls
\ndouble
Cumulative Layout Shift.
lcp
\ndouble
Largest Contentful Paint in milliseconds.
url
\nstring
URL attached to the metrics.
warnings
\n[object]
Warning collected that didn't failed the step.
message [required]
\nstring
Message for the warning.
type [required]
\nenum
User locator used. \nAllowed enum values: user_locator
thumbnailsBucketKey
\nboolean
Whether or not a thumbnail is associated with the browser test.
timeToInteractive
\ndouble
Time in second to wait before the browser test starts after\nreaching the start URL.
result_id
\nstring
ID of the browser test result.
status
\nenum
The status of your Synthetic monitor.
\nO for not triggered1 for triggered2 for no data \nAllowed enum values: 0,1,2tests
\n[object]
Individual synthetics test.
allowInsecureCertificates
\nboolean
Disable certificate checks in API tests.
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 [required]
\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 [required]
\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
\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
\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
\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
\nstring
Type of the data sent in a Synthetic API test.
cookies
\nstring
Cookies for the request.
deviceIds
\n[string]
For browser test, array with the different device IDs used to run the test.
followRedirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
locations
\n[string]
Array of locations used to run the test.
metadata
\nobject
Metadata for the Synthetic tests run.
ci
\nobject
Description of the CI provider.
pipeline
\nobject
Description of the CI pipeline.
url
\nstring
URL of the pipeline.
provider
\nobject
Description of the CI provider.
name
\nstring
Name of the CI provider.
git
\nobject
Git information.
branch
\nstring
Branch name.
commitSha
\nstring
The commit SHA.
public_id [required]
\nstring
The public ID of the Synthetic test to trigger.
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.
startUrl
\nstring
Starting URL for the browser test.
variables
\nobject
Variables to replace in the test.
<any-key>
\nstring
A single variable.
tests
\n[object]
Individual synthetics test.
allowInsecureCertificates
\nboolean
Disable certificate checks in API tests.
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 [required]
\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 [required]
\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
\nstring
Type of the data sent in a Synthetic API test.
cookies
\nstring
Cookies for the request.
deviceIds
\n[string]
For browser test, array with the different device IDs used to run the test.
followRedirects
\nboolean
For API HTTP test, whether or not the test should follow redirects.
headers
\nobject
Headers to include when performing the test.
<any-key>
\nstring
A single Header.
locations
\n[string]
Array of locations used to run the test.
metadata
\nobject
Metadata for the Synthetic tests run.
ci
\nobject
Description of the CI provider.
pipeline
\nobject
Description of the CI pipeline.
url
\nstring
URL of the pipeline.
provider
\nobject
Description of the CI provider.
name
\nstring
Name of the CI provider.
git
\nobject
Git information.
branch
\nstring
Branch name.
commitSha
\nstring
The commit SHA.
public_id [required]
\nstring
The public ID of the Synthetic test to trigger.
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.
startUrl
\nstring
Starting URL for the browser test.
variables
\nobject
Variables to replace in the test.
<any-key>
\nstring
A single variable.
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
config
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
creator
\nobject
Object describing the creator of the shared element.
string
Email of the creator.
handle
\nstring
Handle of the creator.
name
\nstring
Name of the creator.
locations
\n[string]
Array of locations used to run the test.
message
\nstring
Notification message associated with the test.
monitor_id
\nint64
The associated monitor ID.
name
\nstring
Name of the test.
options
\nobject
Object describing the extra options for a Synthetic test.
accept_self_signed
\nboolean
For SSL test, 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.
checkCertificateRevocation
\nboolean
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
ci
\nobject
CI/CD options for a Synthetic test.
executionRule
\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.
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).
renotify_interval
\nint64
Time interval before renotifying if the test is still failing\n(in minutes).
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
\n[object]
Array containing objects describing the scheduling pattern to apply to each day.
day
\nint32
Number representing the day of the week.
from
\nstring
The hour of the day on which scheduling starts.
to
\nstring
The hour of the day on which scheduling ends.
timezone
\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 test public ID.
status
\nenum
Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused
steps
\n[object]
For browser test, the steps of the test.
allowFailure
\nboolean
A boolean set to allow this step to fail.
isCritical
\nboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
name
\nstring
The name of the step.
noScreenshot
\nboolean
A boolean set to not take a screenshot for the step.
params
\nobject
The parameters of the step.
timeout
\nint64
The time before declaring a step failed.
type
\nenum
Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait
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
\nenum
Type of the Synthetic test, either api or browser. \nAllowed enum values: api,browser
check
\nobject
Object describing the API test configuration.
config [required]
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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
\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
\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
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
check_time
\ndouble
When the API test was conducted.
check_version
\nint64
Version of the API test used.
probe_dc
\nstring
Locations for which to query the API test results.
result
\nobject
Object containing results for your Synthetic API test.
cert
\nobject
Object describing the SSL certificate used for a Synthetic test.
cipher
\nstring
Cipher used for the connection.
exponent
\ndouble
Exponent associated to the certificate.
extKeyUsage
\n[string]
Array of extensions and details used for the certificate.
fingerprint
\nstring
MD5 digest of the DER-encoded Certificate information.
fingerprint256
\nstring
SHA-1 digest of the DER-encoded Certificate information.
issuer
\nobject
Object describing the issuer of a SSL certificate.
C
\nstring
Country Name that issued the certificate.
CN
\nstring
Common Name that issued certificate.
L
\nstring
Locality that issued the certificate.
O
\nstring
Organization that issued the certificate.
OU
\nstring
Organizational Unit that issued the certificate.
ST
\nstring
State Or Province Name that issued the certificate.
modulus
\nstring
Modulus associated to the SSL certificate private key.
protocol
\nstring
TLS protocol used for the test.
serialNumber
\nstring
Serial Number assigned by Symantec to the SSL certificate.
subject
\nobject
Object describing the SSL certificate used for the test.
C
\nstring
Country Name associated with the certificate.
CN
\nstring
Common Name that associated with the certificate.
L
\nstring
Locality associated with the certificate.
O
\nstring
Organization associated with the certificate.
OU
\nstring
Organizational Unit associated with the certificate.
ST
\nstring
State Or Province Name associated with the certificate.
altName
\nstring
Subject Alternative Name associated with the certificate.
validFrom
\ndate-time
Date from which the SSL certificate is valid.
validTo
\ndate-time
Date until which the SSL certificate is valid.
eventType
\nenum
Status of a Synthetic test. \nAllowed enum values: not_scheduled,scheduled,finished,finished_with_error
failure
\nobject
The API test failure details.
code
\nenum
Error code that can be returned by a Synthetic test. \nAllowed enum values: BODY_TOO_LARGE,DENIED,TOO_MANY_REDIRECTS,AUTHENTICATION_ERROR,DECRYPTION,INVALID_CHAR_IN_HEADER,HEADER_TOO_LARGE,HEADERS_INCOMPATIBLE_CONTENT_LENGTH,INVALID_REQUEST,REQUIRES_UPDATE,UNESCAPED_CHARACTERS_IN_REQUEST_PATH,MALFORMED_RESPONSE,INCORRECT_ASSERTION,CONNREFUSED,CONNRESET,DNS,HOSTUNREACH,NETUNREACH,TIMEOUT,SSL,OCSP,INVALID_TEST,TUNNEL,WEBSOCKET,UNKNOWN,INTERNAL_ERROR
message
\nstring
The API test error message.
httpStatusCode
\nint64
The API test HTTP status code.
requestHeaders
\nobject
Request header object used for the API test.
<any-key>
\nobject
Requested request header.
responseBody
\nstring
Response body returned for the API test.
responseHeaders
\nobject
Response headers returned for the API test.
<any-key>
\nReturned request header.
responseSize
\nint64
Global size in byte of the API test response.
timings
\nobject
Object containing all metrics and their values collected for a Synthetic API test.\nSee the Synthetic Monitoring Metrics documentation.
dns
\ndouble
The duration in millisecond of the DNS lookup.
download
\ndouble
The time in millisecond to download the response.
firstByte
\ndouble
The time in millisecond to first byte.
handshake
\ndouble
The duration in millisecond of the TLS handshake.
redirect
\ndouble
The time in millisecond spent during redirections.
ssl
\ndouble
The duration in millisecond of the TLS handshake.
tcp
\ndouble
Time in millisecond to establish the TCP connection.
total
\ndouble
The overall time in millisecond the request took to be processed.
wait
\ndouble
Time spent in millisecond waiting for a response.
result_id
\nstring
ID of the API test result.
status
\nenum
The status of your Synthetic monitor.
\nO for not triggered1 for triggered2 for no data \nAllowed enum values: 0,1,2check
\nobject
Object describing the API test configuration.
config [required]
\nobject
Configuration object for a Synthetic 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]
\nValue used by the operator.
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]
\nValue used by the operator.
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
\nThe path target value to compare to.
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
\nThe path target value to compare to.
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
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
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 [required]
\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 [required]
\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:
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.
dnsServer
\nstring
DNS server to use for DNS tests.
dnsServerPort
\nint32
DNS server port to use for DNS tests.
files
\n[object]
Files to be used as part of the request in the test.
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.
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
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
\nint64
Port to use when performing the test.
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.
variables
\n[object]
Browser tests only - array of variables used for the test steps.
example
\nstring
Example for the variable.
id
\nstring
ID for the variable. Global variables require an ID.
name [required]
\nstring
Name of the variable.
pattern
\nstring
Pattern of the variable.
secure
\nboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]
\nenum
Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text
check_time
\ndouble
When the API test was conducted.
check_version
\nint64
Version of the API test used.
probe_dc
\nstring
Locations for which to query the API test results.
result
\nobject
Object containing results for your Synthetic API test.
cert
\nobject
Object describing the SSL certificate used for a Synthetic test.
cipher
\nstring
Cipher used for the connection.
exponent
\ndouble
Exponent associated to the certificate.
extKeyUsage
\n[string]
Array of extensions and details used for the certificate.
fingerprint
\nstring
MD5 digest of the DER-encoded Certificate information.
fingerprint256
\nstring
SHA-1 digest of the DER-encoded Certificate information.
issuer
\nobject
Object describing the issuer of a SSL certificate.
C
\nstring
Country Name that issued the certificate.
CN
\nstring
Common Name that issued certificate.
L
\nstring
Locality that issued the certificate.
O
\nstring
Organization that issued the certificate.
OU
\nstring
Organizational Unit that issued the certificate.
ST
\nstring
State Or Province Name that issued the certificate.
modulus
\nstring
Modulus associated to the SSL certificate private key.
protocol
\nstring
TLS protocol used for the test.
serialNumber
\nstring
Serial Number assigned by Symantec to the SSL certificate.
subject
\nobject
Object describing the SSL certificate used for the test.
C
\nstring
Country Name associated with the certificate.
CN
\nstring
Common Name that associated with the certificate.
L
\nstring
Locality associated with the certificate.
O
\nstring
Organization associated with the certificate.
OU
\nstring
Organizational Unit associated with the certificate.
ST
\nstring
State Or Province Name associated with the certificate.
altName
\nstring
Subject Alternative Name associated with the certificate.
validFrom
\ndate-time
Date from which the SSL certificate is valid.
validTo
\ndate-time
Date until which the SSL certificate is valid.
eventType
\nenum
Status of a Synthetic test. \nAllowed enum values: not_scheduled,scheduled,finished,finished_with_error
failure
\nobject
The API test failure details.
code
\nenum
Error code that can be returned by a Synthetic test. \nAllowed enum values: BODY_TOO_LARGE,DENIED,TOO_MANY_REDIRECTS,AUTHENTICATION_ERROR,DECRYPTION,INVALID_CHAR_IN_HEADER,HEADER_TOO_LARGE,HEADERS_INCOMPATIBLE_CONTENT_LENGTH,INVALID_REQUEST,REQUIRES_UPDATE,UNESCAPED_CHARACTERS_IN_REQUEST_PATH,MALFORMED_RESPONSE,INCORRECT_ASSERTION,CONNREFUSED,CONNRESET,DNS,HOSTUNREACH,NETUNREACH,TIMEOUT,SSL,OCSP,INVALID_TEST,TUNNEL,WEBSOCKET,UNKNOWN,INTERNAL_ERROR
message
\nstring
The API test error message.
httpStatusCode
\nint64
The API test HTTP status code.
requestHeaders
\nobject
Request header object used for the API test.
<any-key>
\nobject
Requested request header.
responseBody
\nstring
Response body returned for the API test.
responseHeaders
\nobject
Response headers returned for the API test.
<any-key>
\nReturned request header.
responseSize
\nint64
Global size in byte of the API test response.
timings
\nobject
Object containing all metrics and their values collected for a Synthetic API test.\nSee the Synthetic Monitoring Metrics documentation.
dns
\ndouble
The duration in millisecond of the DNS lookup.
download
\ndouble
The time in millisecond to download the response.
firstByte
\ndouble
The time in millisecond to first byte.
handshake
\ndouble
The duration in millisecond of the TLS handshake.
redirect
\ndouble
The time in millisecond spent during redirections.
ssl
\ndouble
The duration in millisecond of the TLS handshake.
tcp
\ndouble
Time in millisecond to establish the TCP connection.
total
\ndouble
The overall time in millisecond the request took to be processed.
wait
\ndouble
Time spent in millisecond waiting for a response.
result_id
\nstring
ID of the API test result.
status
\nenum
The status of your Synthetic monitor.
\nO for not triggered1 for triggered2 for no data \nAllowed enum values: 0,1,2