From e97ff059f9faf928cb6f1db1f4888a889a968cc1 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Mon, 9 Dec 2024 11:23:20 +0000 Subject: [PATCH] Regenerate client from commit 21da0df3 of spec repo --- .apigentools-info | 8 ++--- content/en/api/v1/synthetics/examples.json | 10 +++--- ...st.CreateSyntheticsAPITest_1279271422.json | 1 + .../request.CreateSyntheticsBrowserTest.json | 2 ++ data/api/v1/full_spec.yaml | 3 ++ data/api/v1/full_spec_deref.json | 36 +++++++++++++++++++ static/resources/json/full_spec_v1.json | 36 +++++++++++++++++++ 7 files changed, 87 insertions(+), 9 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index 362cad6c6883f..0851940915704 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-05 20:24:11.476192", - "spec_repo_commit": "970515f9" + "regenerated": "2024-12-09 11:23:01.741697", + "spec_repo_commit": "21da0df3" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-05 20:24:19.436525", - "spec_repo_commit": "970515f9" + "regenerated": "2024-12-09 11:23:09.513205", + "spec_repo_commit": "21da0df3" } } } \ No newline at end of file diff --git a/content/en/api/v1/synthetics/examples.json b/content/en/api/v1/synthetics/examples.json index 8055a88373072..ee0152c192269 100644 --- a/content/en/api/v1/synthetics/examples.json +++ b/content/en/api/v1/synthetics/examples.json @@ -1158,7 +1158,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

exitIfSucceed

\n
\n

boolean

\n

Determines whether or not to exit the test if the step succeeds.

\n
\n \n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" }, "400": { "json": { @@ -1385,7 +1385,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

exitIfSucceed

\n
\n

boolean

\n

Determines whether or not to exit the test if the step succeeds.

\n
\n \n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" } }, "GetAPITest": { @@ -1545,7 +1545,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

exitIfSucceed

\n
\n

boolean

\n

Determines whether or not to exit the test if the step succeeds.

\n
\n \n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" }, "403": { "json": { @@ -1735,7 +1735,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

exitIfSucceed

\n
\n

boolean

\n

Determines whether or not to exit the test if the step succeeds.

\n
\n \n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" }, "400": { "json": { @@ -1962,7 +1962,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

exitIfSucceed

\n
\n

boolean

\n

Determines whether or not to exit the test if the step succeeds.

\n
\n \n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

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:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

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.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" } }, "CreateSyntheticsBrowserTest": { diff --git a/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1279271422.json b/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1279271422.json index 8e6fbbf1eda4c..1b0a02cd783da 100644 --- a/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1279271422.json +++ b/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1279271422.json @@ -18,6 +18,7 @@ "target": 200 } ], + "exitIfSucceed": true, "extractedValues": [ { "field": "server", diff --git a/content/en/api/v1/synthetics/request.CreateSyntheticsBrowserTest.json b/content/en/api/v1/synthetics/request.CreateSyntheticsBrowserTest.json index ca7235b62ce9e..5539203f4b81f 100644 --- a/content/en/api/v1/synthetics/request.CreateSyntheticsBrowserTest.json +++ b/content/en/api/v1/synthetics/request.CreateSyntheticsBrowserTest.json @@ -56,6 +56,8 @@ "steps": [ { "allowFailure": false, + "alwaysExecute": true, + "exitIfSucceed": true, "isCritical": true, "name": "Refresh page", "params": {}, diff --git a/data/api/v1/full_spec.yaml b/data/api/v1/full_spec.yaml index c357c9c0cde9d..cb323da270368 100644 --- a/data/api/v1/full_spec.yaml +++ b/data/api/v1/full_spec.yaml @@ -13977,6 +13977,9 @@ components: items: $ref: '#/components/schemas/SyntheticsAssertion' type: array + exitIfSucceed: + description: Determines whether or not to exit the test if the step succeeds. + type: boolean extractedValues: description: Array of values to parse and save as variables from the response. items: diff --git a/data/api/v1/full_spec_deref.json b/data/api/v1/full_spec_deref.json index 315e966bc5a2f..f1abefb3cedc8 100644 --- a/data/api/v1/full_spec_deref.json +++ b/data/api/v1/full_spec_deref.json @@ -487886,6 +487886,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -490255,6 +490259,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -493022,6 +493030,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -497392,6 +497404,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1079326,6 +1079342,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1082105,6 +1082125,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1085075,6 +1085099,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1087977,6 +1088005,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1090756,6 +1090788,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { diff --git a/static/resources/json/full_spec_v1.json b/static/resources/json/full_spec_v1.json index 315e966bc5a2f..f1abefb3cedc8 100644 --- a/static/resources/json/full_spec_v1.json +++ b/static/resources/json/full_spec_v1.json @@ -487886,6 +487886,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -490255,6 +490259,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -493022,6 +493030,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -497392,6 +497404,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1079326,6 +1079342,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1082105,6 +1082125,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1085075,6 +1085099,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1087977,6 +1088005,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": { @@ -1090756,6 +1090788,10 @@ }, "type": "array" }, + "exitIfSucceed": { + "description": "Determines whether or not to exit the test if the step succeeds.", + "type": "boolean" + }, "extractedValues": { "description": "Array of values to parse and save as variables from the response.", "items": {